@vercel/sdk 1.6.7 → 1.6.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/README.md +17 -29
  2. package/bin/mcp-server.js +2689 -996
  3. package/bin/mcp-server.js.map +33 -30
  4. package/docs/sdks/vercel/README.md +77 -0
  5. package/esm/__tests__/environment.test.js +28 -4
  6. package/esm/__tests__/environment.test.js.map +1 -1
  7. package/esm/__tests__/projects.test.js +13 -15
  8. package/esm/__tests__/projects.test.js.map +1 -1
  9. package/esm/__tests__/vercel.test.d.ts +2 -0
  10. package/esm/__tests__/vercel.test.d.ts.map +1 -0
  11. package/esm/__tests__/vercel.test.js +21 -0
  12. package/esm/__tests__/vercel.test.js.map +1 -0
  13. package/esm/funcs/marketplaceUpdateResourceSecretsById.js +2 -2
  14. package/esm/funcs/marketplaceUpdateResourceSecretsById.js.map +1 -1
  15. package/esm/funcs/patchAliasesIdProtectionBypass.d.ts +18 -0
  16. package/esm/funcs/patchAliasesIdProtectionBypass.d.ts.map +1 -0
  17. package/esm/funcs/patchAliasesIdProtectionBypass.js +81 -0
  18. package/esm/funcs/patchAliasesIdProtectionBypass.js.map +1 -0
  19. package/esm/lib/config.d.ts +3 -3
  20. package/esm/lib/config.js +3 -3
  21. package/esm/lib/sdks.d.ts +3 -1
  22. package/esm/lib/sdks.d.ts.map +1 -1
  23. package/esm/lib/sdks.js +6 -11
  24. package/esm/lib/sdks.js.map +1 -1
  25. package/esm/mcp-server/mcp-server.js +1 -1
  26. package/esm/mcp-server/server.d.ts.map +1 -1
  27. package/esm/mcp-server/server.js +3 -1
  28. package/esm/mcp-server/server.js.map +1 -1
  29. package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.d.ts +7 -0
  30. package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.d.ts.map +1 -0
  31. package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.js +26 -0
  32. package/esm/mcp-server/tools/patchAliasesIdProtectionBypass.js.map +1 -0
  33. package/esm/models/authuser.d.ts +0 -8
  34. package/esm/models/authuser.d.ts.map +1 -1
  35. package/esm/models/authuser.js +0 -3
  36. package/esm/models/authuser.js.map +1 -1
  37. package/esm/models/canceldeploymentop.d.ts +268 -26
  38. package/esm/models/canceldeploymentop.d.ts.map +1 -1
  39. package/esm/models/canceldeploymentop.js +194 -24
  40. package/esm/models/canceldeploymentop.js.map +1 -1
  41. package/esm/models/createcustomenvironmentop.d.ts +244 -2
  42. package/esm/models/createcustomenvironmentop.d.ts.map +1 -1
  43. package/esm/models/createcustomenvironmentop.js +174 -2
  44. package/esm/models/createcustomenvironmentop.js.map +1 -1
  45. package/esm/models/createdeploymentop.d.ts +357 -58
  46. package/esm/models/createdeploymentop.d.ts.map +1 -1
  47. package/esm/models/createdeploymentop.js +290 -60
  48. package/esm/models/createdeploymentop.js.map +1 -1
  49. package/esm/models/createprojectenvop.d.ts +6 -6
  50. package/esm/models/createprojectenvop.js +2 -2
  51. package/esm/models/createprojectenvop.js.map +1 -1
  52. package/esm/models/createprojectop.d.ts +337 -80
  53. package/esm/models/createprojectop.d.ts.map +1 -1
  54. package/esm/models/createprojectop.js +256 -78
  55. package/esm/models/createprojectop.js.map +1 -1
  56. package/esm/models/createrecordop.d.ts +43 -43
  57. package/esm/models/createrecordop.d.ts.map +1 -1
  58. package/esm/models/createrecordop.js +51 -51
  59. package/esm/models/createrecordop.js.map +1 -1
  60. package/esm/models/editprojectenvop.d.ts +3 -3
  61. package/esm/models/editprojectenvop.js +1 -1
  62. package/esm/models/editprojectenvop.js.map +1 -1
  63. package/esm/models/getaliasop.d.ts +8 -8
  64. package/esm/models/getaliasop.d.ts.map +1 -1
  65. package/esm/models/getaliasop.js +12 -13
  66. package/esm/models/getaliasop.js.map +1 -1
  67. package/esm/models/getbypassipop.d.ts +28 -28
  68. package/esm/models/getbypassipop.d.ts.map +1 -1
  69. package/esm/models/getbypassipop.js +28 -28
  70. package/esm/models/getbypassipop.js.map +1 -1
  71. package/esm/models/getcustomenvironmentop.d.ts +242 -2
  72. package/esm/models/getcustomenvironmentop.d.ts.map +1 -1
  73. package/esm/models/getcustomenvironmentop.js +175 -2
  74. package/esm/models/getcustomenvironmentop.js.map +1 -1
  75. package/esm/models/getdeploymentop.d.ts +502 -18
  76. package/esm/models/getdeploymentop.d.ts.map +1 -1
  77. package/esm/models/getdeploymentop.js +354 -14
  78. package/esm/models/getdeploymentop.js.map +1 -1
  79. package/esm/models/getprojectdomainsop.d.ts +30 -30
  80. package/esm/models/getprojectdomainsop.d.ts.map +1 -1
  81. package/esm/models/getprojectdomainsop.js +32 -32
  82. package/esm/models/getprojectdomainsop.js.map +1 -1
  83. package/esm/models/getprojectsop.d.ts +342 -95
  84. package/esm/models/getprojectsop.d.ts.map +1 -1
  85. package/esm/models/getprojectsop.js +285 -112
  86. package/esm/models/getprojectsop.js.map +1 -1
  87. package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts +242 -2
  88. package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts.map +1 -1
  89. package/esm/models/getv9projectsidornamecustomenvironmentsop.js +172 -2
  90. package/esm/models/getv9projectsidornamecustomenvironmentsop.js.map +1 -1
  91. package/esm/models/listaliasesop.d.ts +8 -8
  92. package/esm/models/listaliasesop.d.ts.map +1 -1
  93. package/esm/models/listaliasesop.js +12 -12
  94. package/esm/models/listaliasesop.js.map +1 -1
  95. package/esm/models/patchaliasesidprotectionbypassop.d.ts +409 -0
  96. package/esm/models/patchaliasesidprotectionbypassop.d.ts.map +1 -0
  97. package/esm/models/patchaliasesidprotectionbypassop.js +386 -0
  98. package/esm/models/patchaliasesidprotectionbypassop.js.map +1 -0
  99. package/esm/models/removecustomenvironmentop.d.ts +245 -2
  100. package/esm/models/removecustomenvironmentop.d.ts.map +1 -1
  101. package/esm/models/removecustomenvironmentop.js +173 -2
  102. package/esm/models/removecustomenvironmentop.js.map +1 -1
  103. package/esm/models/removeprojectenvop.d.ts +9 -9
  104. package/esm/models/removeprojectenvop.js +3 -3
  105. package/esm/models/removeprojectenvop.js.map +1 -1
  106. package/esm/models/updatecustomenvironmentop.d.ts +244 -2
  107. package/esm/models/updatecustomenvironmentop.d.ts.map +1 -1
  108. package/esm/models/updatecustomenvironmentop.js +174 -2
  109. package/esm/models/updatecustomenvironmentop.js.map +1 -1
  110. package/esm/models/updateprojectdatacacheop.d.ts +358 -111
  111. package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
  112. package/esm/models/updateprojectdatacacheop.js +309 -135
  113. package/esm/models/updateprojectdatacacheop.js.map +1 -1
  114. package/esm/models/updateprojectop.d.ts +420 -104
  115. package/esm/models/updateprojectop.d.ts.map +1 -1
  116. package/esm/models/updateprojectop.js +342 -114
  117. package/esm/models/updateprojectop.js.map +1 -1
  118. package/esm/models/userevent.d.ts +161 -86
  119. package/esm/models/userevent.d.ts.map +1 -1
  120. package/esm/models/userevent.js +139 -64
  121. package/esm/models/userevent.js.map +1 -1
  122. package/esm/sdk/sdk.d.ts +8 -1
  123. package/esm/sdk/sdk.d.ts.map +1 -1
  124. package/esm/sdk/sdk.js +8 -0
  125. package/esm/sdk/sdk.js.map +1 -1
  126. package/jsr.json +1 -1
  127. package/package.json +1 -1
  128. package/src/__tests__/environment.test.ts +28 -4
  129. package/src/__tests__/projects.test.ts +13 -15
  130. package/src/__tests__/vercel.test.ts +26 -0
  131. package/src/funcs/marketplaceUpdateResourceSecretsById.ts +2 -2
  132. package/src/funcs/patchAliasesIdProtectionBypass.ts +185 -0
  133. package/src/lib/config.ts +3 -3
  134. package/src/lib/sdks.ts +11 -11
  135. package/src/mcp-server/mcp-server.ts +1 -1
  136. package/src/mcp-server/server.ts +3 -1
  137. package/src/mcp-server/tools/patchAliasesIdProtectionBypass.ts +37 -0
  138. package/src/models/authuser.ts +0 -8
  139. package/src/models/canceldeploymentop.ts +503 -43
  140. package/src/models/createcustomenvironmentop.ts +426 -4
  141. package/src/models/createdeploymentop.ts +640 -117
  142. package/src/models/createprojectenvop.ts +2 -2
  143. package/src/models/createprojectop.ts +658 -201
  144. package/src/models/createrecordop.ts +96 -84
  145. package/src/models/editprojectenvop.ts +1 -1
  146. package/src/models/getaliasop.ts +16 -14
  147. package/src/models/getbypassipop.ts +56 -56
  148. package/src/models/getcustomenvironmentop.ts +412 -4
  149. package/src/models/getdeploymentop.ts +962 -49
  150. package/src/models/getprojectdomainsop.ts +84 -84
  151. package/src/models/getprojectsop.ts +630 -189
  152. package/src/models/getv9projectsidornamecustomenvironmentsop.ts +473 -4
  153. package/src/models/listaliasesop.ts +19 -16
  154. package/src/models/patchaliasesidprotectionbypassop.ts +786 -0
  155. package/src/models/removecustomenvironmentop.ts +425 -4
  156. package/src/models/removeprojectenvop.ts +3 -3
  157. package/src/models/updatecustomenvironmentop.ts +437 -4
  158. package/src/models/updateprojectdatacacheop.ts +731 -271
  159. package/src/models/updateprojectop.ts +786 -197
  160. package/src/models/userevent.ts +246 -121
  161. package/src/sdk/sdk.ts +18 -1
  162. package/vercel-spec.json +2609 -140
package/vercel-spec.json CHANGED
@@ -4812,7 +4812,161 @@
4812
4812
  },
4813
4813
  "customEnvironments": {
4814
4814
  "items": {
4815
- "type": "object"
4815
+ "properties": {
4816
+ "id": {
4817
+ "type": "string",
4818
+ "description": "Unique identifier for the custom environment (format: env_*)"
4819
+ },
4820
+ "slug": {
4821
+ "type": "string",
4822
+ "description": "URL-friendly name of the environment"
4823
+ },
4824
+ "type": {
4825
+ "type": "string",
4826
+ "enum": [
4827
+ "production",
4828
+ "preview",
4829
+ "development"
4830
+ ],
4831
+ "description": "The type of environment (production, preview, or development)"
4832
+ },
4833
+ "description": {
4834
+ "type": "string",
4835
+ "description": "Optional description of the environment's purpose"
4836
+ },
4837
+ "branchMatcher": {
4838
+ "properties": {
4839
+ "type": {
4840
+ "type": "string",
4841
+ "enum": [
4842
+ "endsWith",
4843
+ "startsWith",
4844
+ "equals"
4845
+ ],
4846
+ "description": "The type of matching to perform"
4847
+ },
4848
+ "pattern": {
4849
+ "type": "string",
4850
+ "description": "The pattern to match against branch names"
4851
+ }
4852
+ },
4853
+ "required": [
4854
+ "type",
4855
+ "pattern"
4856
+ ],
4857
+ "type": "object",
4858
+ "description": "Configuration for matching git branches to this environment"
4859
+ },
4860
+ "domains": {
4861
+ "items": {
4862
+ "properties": {
4863
+ "name": {
4864
+ "type": "string"
4865
+ },
4866
+ "apexName": {
4867
+ "type": "string"
4868
+ },
4869
+ "projectId": {
4870
+ "type": "string"
4871
+ },
4872
+ "redirect": {
4873
+ "nullable": true,
4874
+ "type": "string"
4875
+ },
4876
+ "redirectStatusCode": {
4877
+ "nullable": true,
4878
+ "type": "number",
4879
+ "enum": [
4880
+ 307,
4881
+ 301,
4882
+ 302,
4883
+ 308
4884
+ ]
4885
+ },
4886
+ "gitBranch": {
4887
+ "nullable": true,
4888
+ "type": "string"
4889
+ },
4890
+ "customEnvironmentId": {
4891
+ "nullable": true,
4892
+ "type": "string"
4893
+ },
4894
+ "updatedAt": {
4895
+ "type": "number"
4896
+ },
4897
+ "createdAt": {
4898
+ "type": "number"
4899
+ },
4900
+ "verified": {
4901
+ "type": "boolean",
4902
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
4903
+ },
4904
+ "verification": {
4905
+ "items": {
4906
+ "properties": {
4907
+ "type": {
4908
+ "type": "string"
4909
+ },
4910
+ "domain": {
4911
+ "type": "string"
4912
+ },
4913
+ "value": {
4914
+ "type": "string"
4915
+ },
4916
+ "reason": {
4917
+ "type": "string"
4918
+ }
4919
+ },
4920
+ "required": [
4921
+ "type",
4922
+ "domain",
4923
+ "value",
4924
+ "reason"
4925
+ ],
4926
+ "type": "object",
4927
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
4928
+ },
4929
+ "type": "array",
4930
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
4931
+ }
4932
+ },
4933
+ "required": [
4934
+ "name",
4935
+ "apexName",
4936
+ "projectId",
4937
+ "verified"
4938
+ ],
4939
+ "type": "object",
4940
+ "description": "List of domains associated with this environment"
4941
+ },
4942
+ "type": "array",
4943
+ "description": "List of domains associated with this environment"
4944
+ },
4945
+ "currentDeploymentAliases": {
4946
+ "items": {
4947
+ "type": "string"
4948
+ },
4949
+ "type": "array",
4950
+ "description": "List of aliases for the current deployment"
4951
+ },
4952
+ "createdAt": {
4953
+ "type": "number",
4954
+ "description": "Timestamp when the environment was created"
4955
+ },
4956
+ "updatedAt": {
4957
+ "type": "number",
4958
+ "description": "Timestamp when the environment was last updated"
4959
+ }
4960
+ },
4961
+ "required": [
4962
+ "id",
4963
+ "slug",
4964
+ "type",
4965
+ "createdAt",
4966
+ "updatedAt"
4967
+ ],
4968
+ "type": "object",
4969
+ "description": "Internal representation of a custom environment with all required properties"
4816
4970
  },
4817
4971
  "type": "array"
4818
4972
  },
@@ -5781,8 +5935,8 @@
5781
5935
  "deploymentType": {
5782
5936
  "type": "string",
5783
5937
  "enum": [
5784
- "all",
5785
5938
  "preview",
5939
+ "all",
5786
5940
  "prod_deployment_urls_and_all_previews"
5787
5941
  ]
5788
5942
  }
@@ -7304,6 +7458,10 @@
7304
7458
  "toDeploymentId": {
7305
7459
  "type": "string"
7306
7460
  },
7461
+ "fromRollingReleaseId": {
7462
+ "type": "string",
7463
+ "description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
7464
+ },
7307
7465
  "jobStatus": {
7308
7466
  "type": "string",
7309
7467
  "enum": [
@@ -7370,10 +7528,10 @@
7370
7528
  "deploymentType": {
7371
7529
  "type": "string",
7372
7530
  "enum": [
7373
- "all",
7531
+ "production",
7374
7532
  "preview",
7375
- "prod_deployment_urls_and_all_previews",
7376
- "production"
7533
+ "all",
7534
+ "prod_deployment_urls_and_all_previews"
7377
7535
  ]
7378
7536
  },
7379
7537
  "addresses": {
@@ -7413,10 +7571,10 @@
7413
7571
  "deploymentType": {
7414
7572
  "type": "string",
7415
7573
  "enum": [
7416
- "all",
7574
+ "production",
7417
7575
  "preview",
7418
- "prod_deployment_urls_and_all_previews",
7419
- "production"
7576
+ "all",
7577
+ "prod_deployment_urls_and_all_previews"
7420
7578
  ]
7421
7579
  }
7422
7580
  },
@@ -8806,7 +8964,161 @@
8806
8964
  "customEnvironment": {
8807
8965
  "oneOf": [
8808
8966
  {
8809
- "type": "object"
8967
+ "properties": {
8968
+ "id": {
8969
+ "type": "string",
8970
+ "description": "Unique identifier for the custom environment (format: env_*)"
8971
+ },
8972
+ "slug": {
8973
+ "type": "string",
8974
+ "description": "URL-friendly name of the environment"
8975
+ },
8976
+ "type": {
8977
+ "type": "string",
8978
+ "enum": [
8979
+ "production",
8980
+ "preview",
8981
+ "development"
8982
+ ],
8983
+ "description": "The type of environment (production, preview, or development)"
8984
+ },
8985
+ "description": {
8986
+ "type": "string",
8987
+ "description": "Optional description of the environment's purpose"
8988
+ },
8989
+ "branchMatcher": {
8990
+ "properties": {
8991
+ "type": {
8992
+ "type": "string",
8993
+ "enum": [
8994
+ "startsWith",
8995
+ "equals",
8996
+ "endsWith"
8997
+ ],
8998
+ "description": "The type of matching to perform"
8999
+ },
9000
+ "pattern": {
9001
+ "type": "string",
9002
+ "description": "The pattern to match against branch names"
9003
+ }
9004
+ },
9005
+ "required": [
9006
+ "type",
9007
+ "pattern"
9008
+ ],
9009
+ "type": "object",
9010
+ "description": "Configuration for matching git branches to this environment"
9011
+ },
9012
+ "domains": {
9013
+ "items": {
9014
+ "properties": {
9015
+ "name": {
9016
+ "type": "string"
9017
+ },
9018
+ "apexName": {
9019
+ "type": "string"
9020
+ },
9021
+ "projectId": {
9022
+ "type": "string"
9023
+ },
9024
+ "redirect": {
9025
+ "nullable": true,
9026
+ "type": "string"
9027
+ },
9028
+ "redirectStatusCode": {
9029
+ "nullable": true,
9030
+ "type": "number",
9031
+ "enum": [
9032
+ 307,
9033
+ 301,
9034
+ 302,
9035
+ 308
9036
+ ]
9037
+ },
9038
+ "gitBranch": {
9039
+ "nullable": true,
9040
+ "type": "string"
9041
+ },
9042
+ "customEnvironmentId": {
9043
+ "nullable": true,
9044
+ "type": "string"
9045
+ },
9046
+ "updatedAt": {
9047
+ "type": "number"
9048
+ },
9049
+ "createdAt": {
9050
+ "type": "number"
9051
+ },
9052
+ "verified": {
9053
+ "type": "boolean",
9054
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
9055
+ },
9056
+ "verification": {
9057
+ "items": {
9058
+ "properties": {
9059
+ "type": {
9060
+ "type": "string"
9061
+ },
9062
+ "domain": {
9063
+ "type": "string"
9064
+ },
9065
+ "value": {
9066
+ "type": "string"
9067
+ },
9068
+ "reason": {
9069
+ "type": "string"
9070
+ }
9071
+ },
9072
+ "required": [
9073
+ "type",
9074
+ "domain",
9075
+ "value",
9076
+ "reason"
9077
+ ],
9078
+ "type": "object",
9079
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
9080
+ },
9081
+ "type": "array",
9082
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
9083
+ }
9084
+ },
9085
+ "required": [
9086
+ "name",
9087
+ "apexName",
9088
+ "projectId",
9089
+ "verified"
9090
+ ],
9091
+ "type": "object",
9092
+ "description": "List of domains associated with this environment"
9093
+ },
9094
+ "type": "array",
9095
+ "description": "List of domains associated with this environment"
9096
+ },
9097
+ "currentDeploymentAliases": {
9098
+ "items": {
9099
+ "type": "string"
9100
+ },
9101
+ "type": "array",
9102
+ "description": "List of aliases for the current deployment"
9103
+ },
9104
+ "createdAt": {
9105
+ "type": "number",
9106
+ "description": "Timestamp when the environment was created"
9107
+ },
9108
+ "updatedAt": {
9109
+ "type": "number",
9110
+ "description": "Timestamp when the environment was last updated"
9111
+ }
9112
+ },
9113
+ "required": [
9114
+ "id",
9115
+ "slug",
9116
+ "type",
9117
+ "createdAt",
9118
+ "updatedAt"
9119
+ ],
9120
+ "type": "object",
9121
+ "description": "Internal representation of a custom environment with all required properties"
8810
9122
  },
8811
9123
  {
8812
9124
  "properties": {
@@ -9263,7 +9575,7 @@
9263
9575
  "type": {
9264
9576
  "type": "string",
9265
9577
  "enum": [
9266
- "github"
9578
+ "github-custom-host"
9267
9579
  ]
9268
9580
  },
9269
9581
  "host": {
@@ -10316,7 +10628,161 @@
10316
10628
  "customEnvironment": {
10317
10629
  "oneOf": [
10318
10630
  {
10319
- "type": "object"
10631
+ "properties": {
10632
+ "id": {
10633
+ "type": "string",
10634
+ "description": "Unique identifier for the custom environment (format: env_*)"
10635
+ },
10636
+ "slug": {
10637
+ "type": "string",
10638
+ "description": "URL-friendly name of the environment"
10639
+ },
10640
+ "type": {
10641
+ "type": "string",
10642
+ "enum": [
10643
+ "production",
10644
+ "preview",
10645
+ "development"
10646
+ ],
10647
+ "description": "The type of environment (production, preview, or development)"
10648
+ },
10649
+ "description": {
10650
+ "type": "string",
10651
+ "description": "Optional description of the environment's purpose"
10652
+ },
10653
+ "branchMatcher": {
10654
+ "properties": {
10655
+ "type": {
10656
+ "type": "string",
10657
+ "enum": [
10658
+ "startsWith",
10659
+ "equals",
10660
+ "endsWith"
10661
+ ],
10662
+ "description": "The type of matching to perform"
10663
+ },
10664
+ "pattern": {
10665
+ "type": "string",
10666
+ "description": "The pattern to match against branch names"
10667
+ }
10668
+ },
10669
+ "required": [
10670
+ "type",
10671
+ "pattern"
10672
+ ],
10673
+ "type": "object",
10674
+ "description": "Configuration for matching git branches to this environment"
10675
+ },
10676
+ "domains": {
10677
+ "items": {
10678
+ "properties": {
10679
+ "name": {
10680
+ "type": "string"
10681
+ },
10682
+ "apexName": {
10683
+ "type": "string"
10684
+ },
10685
+ "projectId": {
10686
+ "type": "string"
10687
+ },
10688
+ "redirect": {
10689
+ "nullable": true,
10690
+ "type": "string"
10691
+ },
10692
+ "redirectStatusCode": {
10693
+ "nullable": true,
10694
+ "type": "number",
10695
+ "enum": [
10696
+ 307,
10697
+ 301,
10698
+ 302,
10699
+ 308
10700
+ ]
10701
+ },
10702
+ "gitBranch": {
10703
+ "nullable": true,
10704
+ "type": "string"
10705
+ },
10706
+ "customEnvironmentId": {
10707
+ "nullable": true,
10708
+ "type": "string"
10709
+ },
10710
+ "updatedAt": {
10711
+ "type": "number"
10712
+ },
10713
+ "createdAt": {
10714
+ "type": "number"
10715
+ },
10716
+ "verified": {
10717
+ "type": "boolean",
10718
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
10719
+ },
10720
+ "verification": {
10721
+ "items": {
10722
+ "properties": {
10723
+ "type": {
10724
+ "type": "string"
10725
+ },
10726
+ "domain": {
10727
+ "type": "string"
10728
+ },
10729
+ "value": {
10730
+ "type": "string"
10731
+ },
10732
+ "reason": {
10733
+ "type": "string"
10734
+ }
10735
+ },
10736
+ "required": [
10737
+ "type",
10738
+ "domain",
10739
+ "value",
10740
+ "reason"
10741
+ ],
10742
+ "type": "object",
10743
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
10744
+ },
10745
+ "type": "array",
10746
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
10747
+ }
10748
+ },
10749
+ "required": [
10750
+ "name",
10751
+ "apexName",
10752
+ "projectId",
10753
+ "verified"
10754
+ ],
10755
+ "type": "object",
10756
+ "description": "List of domains associated with this environment"
10757
+ },
10758
+ "type": "array",
10759
+ "description": "List of domains associated with this environment"
10760
+ },
10761
+ "currentDeploymentAliases": {
10762
+ "items": {
10763
+ "type": "string"
10764
+ },
10765
+ "type": "array",
10766
+ "description": "List of aliases for the current deployment"
10767
+ },
10768
+ "createdAt": {
10769
+ "type": "number",
10770
+ "description": "Timestamp when the environment was created"
10771
+ },
10772
+ "updatedAt": {
10773
+ "type": "number",
10774
+ "description": "Timestamp when the environment was last updated"
10775
+ }
10776
+ },
10777
+ "required": [
10778
+ "id",
10779
+ "slug",
10780
+ "type",
10781
+ "createdAt",
10782
+ "updatedAt"
10783
+ ],
10784
+ "type": "object",
10785
+ "description": "Internal representation of a custom environment with all required properties"
10320
10786
  },
10321
10787
  {
10322
10788
  "properties": {
@@ -10773,7 +11239,7 @@
10773
11239
  "type": {
10774
11240
  "type": "string",
10775
11241
  "enum": [
10776
- "github"
11242
+ "github-custom-host"
10777
11243
  ]
10778
11244
  },
10779
11245
  "host": {
@@ -11587,7 +12053,161 @@
11587
12053
  "customEnvironment": {
11588
12054
  "oneOf": [
11589
12055
  {
11590
- "type": "object"
12056
+ "properties": {
12057
+ "id": {
12058
+ "type": "string",
12059
+ "description": "Unique identifier for the custom environment (format: env_*)"
12060
+ },
12061
+ "slug": {
12062
+ "type": "string",
12063
+ "description": "URL-friendly name of the environment"
12064
+ },
12065
+ "type": {
12066
+ "type": "string",
12067
+ "enum": [
12068
+ "production",
12069
+ "preview",
12070
+ "development"
12071
+ ],
12072
+ "description": "The type of environment (production, preview, or development)"
12073
+ },
12074
+ "description": {
12075
+ "type": "string",
12076
+ "description": "Optional description of the environment's purpose"
12077
+ },
12078
+ "branchMatcher": {
12079
+ "properties": {
12080
+ "type": {
12081
+ "type": "string",
12082
+ "enum": [
12083
+ "startsWith",
12084
+ "equals",
12085
+ "endsWith"
12086
+ ],
12087
+ "description": "The type of matching to perform"
12088
+ },
12089
+ "pattern": {
12090
+ "type": "string",
12091
+ "description": "The pattern to match against branch names"
12092
+ }
12093
+ },
12094
+ "required": [
12095
+ "type",
12096
+ "pattern"
12097
+ ],
12098
+ "type": "object",
12099
+ "description": "Configuration for matching git branches to this environment"
12100
+ },
12101
+ "domains": {
12102
+ "items": {
12103
+ "properties": {
12104
+ "name": {
12105
+ "type": "string"
12106
+ },
12107
+ "apexName": {
12108
+ "type": "string"
12109
+ },
12110
+ "projectId": {
12111
+ "type": "string"
12112
+ },
12113
+ "redirect": {
12114
+ "nullable": true,
12115
+ "type": "string"
12116
+ },
12117
+ "redirectStatusCode": {
12118
+ "nullable": true,
12119
+ "type": "number",
12120
+ "enum": [
12121
+ 307,
12122
+ 301,
12123
+ 302,
12124
+ 308
12125
+ ]
12126
+ },
12127
+ "gitBranch": {
12128
+ "nullable": true,
12129
+ "type": "string"
12130
+ },
12131
+ "customEnvironmentId": {
12132
+ "nullable": true,
12133
+ "type": "string"
12134
+ },
12135
+ "updatedAt": {
12136
+ "type": "number"
12137
+ },
12138
+ "createdAt": {
12139
+ "type": "number"
12140
+ },
12141
+ "verified": {
12142
+ "type": "boolean",
12143
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
12144
+ },
12145
+ "verification": {
12146
+ "items": {
12147
+ "properties": {
12148
+ "type": {
12149
+ "type": "string"
12150
+ },
12151
+ "domain": {
12152
+ "type": "string"
12153
+ },
12154
+ "value": {
12155
+ "type": "string"
12156
+ },
12157
+ "reason": {
12158
+ "type": "string"
12159
+ }
12160
+ },
12161
+ "required": [
12162
+ "type",
12163
+ "domain",
12164
+ "value",
12165
+ "reason"
12166
+ ],
12167
+ "type": "object",
12168
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
12169
+ },
12170
+ "type": "array",
12171
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
12172
+ }
12173
+ },
12174
+ "required": [
12175
+ "name",
12176
+ "apexName",
12177
+ "projectId",
12178
+ "verified"
12179
+ ],
12180
+ "type": "object",
12181
+ "description": "List of domains associated with this environment"
12182
+ },
12183
+ "type": "array",
12184
+ "description": "List of domains associated with this environment"
12185
+ },
12186
+ "currentDeploymentAliases": {
12187
+ "items": {
12188
+ "type": "string"
12189
+ },
12190
+ "type": "array",
12191
+ "description": "List of aliases for the current deployment"
12192
+ },
12193
+ "createdAt": {
12194
+ "type": "number",
12195
+ "description": "Timestamp when the environment was created"
12196
+ },
12197
+ "updatedAt": {
12198
+ "type": "number",
12199
+ "description": "Timestamp when the environment was last updated"
12200
+ }
12201
+ },
12202
+ "required": [
12203
+ "id",
12204
+ "slug",
12205
+ "type",
12206
+ "createdAt",
12207
+ "updatedAt"
12208
+ ],
12209
+ "type": "object",
12210
+ "description": "Internal representation of a custom environment with all required properties"
11591
12211
  },
11592
12212
  {
11593
12213
  "properties": {
@@ -11944,7 +12564,7 @@
11944
12564
  "type": {
11945
12565
  "type": "string",
11946
12566
  "enum": [
11947
- "github"
12567
+ "github-custom-host"
11948
12568
  ]
11949
12569
  },
11950
12570
  "host": {
@@ -13214,6 +13834,44 @@
13214
13834
  ],
13215
13835
  "type": "object"
13216
13836
  },
13837
+ {
13838
+ "properties": {
13839
+ "org": {
13840
+ "type": "string",
13841
+ "example": "vercel"
13842
+ },
13843
+ "ref": {
13844
+ "type": "string",
13845
+ "example": "main"
13846
+ },
13847
+ "repo": {
13848
+ "type": "string",
13849
+ "example": "next.js"
13850
+ },
13851
+ "sha": {
13852
+ "type": "string",
13853
+ "example": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0"
13854
+ },
13855
+ "host": {
13856
+ "type": "string"
13857
+ },
13858
+ "type": {
13859
+ "enum": [
13860
+ "github-custom-host"
13861
+ ],
13862
+ "type": "string"
13863
+ }
13864
+ },
13865
+ "required": [
13866
+ "type",
13867
+ "ref",
13868
+ "org",
13869
+ "repo",
13870
+ "host"
13871
+ ],
13872
+ "type": "object",
13873
+ "private": true
13874
+ },
13217
13875
  {
13218
13876
  "properties": {
13219
13877
  "projectId": {
@@ -13993,7 +14651,161 @@
13993
14651
  "customEnvironment": {
13994
14652
  "oneOf": [
13995
14653
  {
13996
- "type": "object"
14654
+ "properties": {
14655
+ "id": {
14656
+ "type": "string",
14657
+ "description": "Unique identifier for the custom environment (format: env_*)"
14658
+ },
14659
+ "slug": {
14660
+ "type": "string",
14661
+ "description": "URL-friendly name of the environment"
14662
+ },
14663
+ "type": {
14664
+ "type": "string",
14665
+ "enum": [
14666
+ "production",
14667
+ "preview",
14668
+ "development"
14669
+ ],
14670
+ "description": "The type of environment (production, preview, or development)"
14671
+ },
14672
+ "description": {
14673
+ "type": "string",
14674
+ "description": "Optional description of the environment's purpose"
14675
+ },
14676
+ "branchMatcher": {
14677
+ "properties": {
14678
+ "type": {
14679
+ "type": "string",
14680
+ "enum": [
14681
+ "startsWith",
14682
+ "equals",
14683
+ "endsWith"
14684
+ ],
14685
+ "description": "The type of matching to perform"
14686
+ },
14687
+ "pattern": {
14688
+ "type": "string",
14689
+ "description": "The pattern to match against branch names"
14690
+ }
14691
+ },
14692
+ "required": [
14693
+ "type",
14694
+ "pattern"
14695
+ ],
14696
+ "type": "object",
14697
+ "description": "Configuration for matching git branches to this environment"
14698
+ },
14699
+ "domains": {
14700
+ "items": {
14701
+ "properties": {
14702
+ "name": {
14703
+ "type": "string"
14704
+ },
14705
+ "apexName": {
14706
+ "type": "string"
14707
+ },
14708
+ "projectId": {
14709
+ "type": "string"
14710
+ },
14711
+ "redirect": {
14712
+ "nullable": true,
14713
+ "type": "string"
14714
+ },
14715
+ "redirectStatusCode": {
14716
+ "nullable": true,
14717
+ "type": "number",
14718
+ "enum": [
14719
+ 307,
14720
+ 301,
14721
+ 302,
14722
+ 308
14723
+ ]
14724
+ },
14725
+ "gitBranch": {
14726
+ "nullable": true,
14727
+ "type": "string"
14728
+ },
14729
+ "customEnvironmentId": {
14730
+ "nullable": true,
14731
+ "type": "string"
14732
+ },
14733
+ "updatedAt": {
14734
+ "type": "number"
14735
+ },
14736
+ "createdAt": {
14737
+ "type": "number"
14738
+ },
14739
+ "verified": {
14740
+ "type": "boolean",
14741
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
14742
+ },
14743
+ "verification": {
14744
+ "items": {
14745
+ "properties": {
14746
+ "type": {
14747
+ "type": "string"
14748
+ },
14749
+ "domain": {
14750
+ "type": "string"
14751
+ },
14752
+ "value": {
14753
+ "type": "string"
14754
+ },
14755
+ "reason": {
14756
+ "type": "string"
14757
+ }
14758
+ },
14759
+ "required": [
14760
+ "type",
14761
+ "domain",
14762
+ "value",
14763
+ "reason"
14764
+ ],
14765
+ "type": "object",
14766
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
14767
+ },
14768
+ "type": "array",
14769
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
14770
+ }
14771
+ },
14772
+ "required": [
14773
+ "name",
14774
+ "apexName",
14775
+ "projectId",
14776
+ "verified"
14777
+ ],
14778
+ "type": "object",
14779
+ "description": "List of domains associated with this environment"
14780
+ },
14781
+ "type": "array",
14782
+ "description": "List of domains associated with this environment"
14783
+ },
14784
+ "currentDeploymentAliases": {
14785
+ "items": {
14786
+ "type": "string"
14787
+ },
14788
+ "type": "array",
14789
+ "description": "List of aliases for the current deployment"
14790
+ },
14791
+ "createdAt": {
14792
+ "type": "number",
14793
+ "description": "Timestamp when the environment was created"
14794
+ },
14795
+ "updatedAt": {
14796
+ "type": "number",
14797
+ "description": "Timestamp when the environment was last updated"
14798
+ }
14799
+ },
14800
+ "required": [
14801
+ "id",
14802
+ "slug",
14803
+ "type",
14804
+ "createdAt",
14805
+ "updatedAt"
14806
+ ],
14807
+ "type": "object",
14808
+ "description": "Internal representation of a custom environment with all required properties"
13997
14809
  },
13998
14810
  {
13999
14811
  "properties": {
@@ -14430,7 +15242,7 @@
14430
15242
  "type": {
14431
15243
  "type": "string",
14432
15244
  "enum": [
14433
- "github"
15245
+ "github-custom-host"
14434
15246
  ]
14435
15247
  },
14436
15248
  "host": {
@@ -22730,6 +23542,9 @@
22730
23542
  }
22731
23543
  }
22732
23544
  }
23545
+ },
23546
+ "422": {
23547
+ "description": ""
22733
23548
  }
22734
23549
  },
22735
23550
  "parameters": [
@@ -26499,7 +27314,161 @@
26499
27314
  },
26500
27315
  "customEnvironments": {
26501
27316
  "items": {
26502
- "type": "object"
27317
+ "properties": {
27318
+ "id": {
27319
+ "type": "string",
27320
+ "description": "Unique identifier for the custom environment (format: env_*)"
27321
+ },
27322
+ "slug": {
27323
+ "type": "string",
27324
+ "description": "URL-friendly name of the environment"
27325
+ },
27326
+ "type": {
27327
+ "type": "string",
27328
+ "enum": [
27329
+ "production",
27330
+ "preview",
27331
+ "development"
27332
+ ],
27333
+ "description": "The type of environment (production, preview, or development)"
27334
+ },
27335
+ "description": {
27336
+ "type": "string",
27337
+ "description": "Optional description of the environment's purpose"
27338
+ },
27339
+ "branchMatcher": {
27340
+ "properties": {
27341
+ "type": {
27342
+ "type": "string",
27343
+ "enum": [
27344
+ "endsWith",
27345
+ "startsWith",
27346
+ "equals"
27347
+ ],
27348
+ "description": "The type of matching to perform"
27349
+ },
27350
+ "pattern": {
27351
+ "type": "string",
27352
+ "description": "The pattern to match against branch names"
27353
+ }
27354
+ },
27355
+ "required": [
27356
+ "type",
27357
+ "pattern"
27358
+ ],
27359
+ "type": "object",
27360
+ "description": "Configuration for matching git branches to this environment"
27361
+ },
27362
+ "domains": {
27363
+ "items": {
27364
+ "properties": {
27365
+ "name": {
27366
+ "type": "string"
27367
+ },
27368
+ "apexName": {
27369
+ "type": "string"
27370
+ },
27371
+ "projectId": {
27372
+ "type": "string"
27373
+ },
27374
+ "redirect": {
27375
+ "nullable": true,
27376
+ "type": "string"
27377
+ },
27378
+ "redirectStatusCode": {
27379
+ "nullable": true,
27380
+ "type": "number",
27381
+ "enum": [
27382
+ 307,
27383
+ 301,
27384
+ 302,
27385
+ 308
27386
+ ]
27387
+ },
27388
+ "gitBranch": {
27389
+ "nullable": true,
27390
+ "type": "string"
27391
+ },
27392
+ "customEnvironmentId": {
27393
+ "nullable": true,
27394
+ "type": "string"
27395
+ },
27396
+ "updatedAt": {
27397
+ "type": "number"
27398
+ },
27399
+ "createdAt": {
27400
+ "type": "number"
27401
+ },
27402
+ "verified": {
27403
+ "type": "boolean",
27404
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
27405
+ },
27406
+ "verification": {
27407
+ "items": {
27408
+ "properties": {
27409
+ "type": {
27410
+ "type": "string"
27411
+ },
27412
+ "domain": {
27413
+ "type": "string"
27414
+ },
27415
+ "value": {
27416
+ "type": "string"
27417
+ },
27418
+ "reason": {
27419
+ "type": "string"
27420
+ }
27421
+ },
27422
+ "required": [
27423
+ "type",
27424
+ "domain",
27425
+ "value",
27426
+ "reason"
27427
+ ],
27428
+ "type": "object",
27429
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
27430
+ },
27431
+ "type": "array",
27432
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
27433
+ }
27434
+ },
27435
+ "required": [
27436
+ "name",
27437
+ "apexName",
27438
+ "projectId",
27439
+ "verified"
27440
+ ],
27441
+ "type": "object",
27442
+ "description": "List of domains associated with this environment"
27443
+ },
27444
+ "type": "array",
27445
+ "description": "List of domains associated with this environment"
27446
+ },
27447
+ "currentDeploymentAliases": {
27448
+ "items": {
27449
+ "type": "string"
27450
+ },
27451
+ "type": "array",
27452
+ "description": "List of aliases for the current deployment"
27453
+ },
27454
+ "createdAt": {
27455
+ "type": "number",
27456
+ "description": "Timestamp when the environment was created"
27457
+ },
27458
+ "updatedAt": {
27459
+ "type": "number",
27460
+ "description": "Timestamp when the environment was last updated"
27461
+ }
27462
+ },
27463
+ "required": [
27464
+ "id",
27465
+ "slug",
27466
+ "type",
27467
+ "createdAt",
27468
+ "updatedAt"
27469
+ ],
27470
+ "type": "object",
27471
+ "description": "Internal representation of a custom environment with all required properties"
26503
27472
  },
26504
27473
  "type": "array"
26505
27474
  },
@@ -27468,8 +28437,8 @@
27468
28437
  "deploymentType": {
27469
28438
  "type": "string",
27470
28439
  "enum": [
27471
- "all",
27472
28440
  "preview",
28441
+ "all",
27473
28442
  "prod_deployment_urls_and_all_previews"
27474
28443
  ]
27475
28444
  }
@@ -28991,6 +29960,10 @@
28991
29960
  "toDeploymentId": {
28992
29961
  "type": "string"
28993
29962
  },
29963
+ "fromRollingReleaseId": {
29964
+ "type": "string",
29965
+ "description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
29966
+ },
28994
29967
  "jobStatus": {
28995
29968
  "type": "string",
28996
29969
  "enum": [
@@ -29057,10 +30030,10 @@
29057
30030
  "deploymentType": {
29058
30031
  "type": "string",
29059
30032
  "enum": [
29060
- "all",
30033
+ "production",
29061
30034
  "preview",
29062
- "prod_deployment_urls_and_all_previews",
29063
- "production"
30035
+ "all",
30036
+ "prod_deployment_urls_and_all_previews"
29064
30037
  ]
29065
30038
  },
29066
30039
  "addresses": {
@@ -29100,10 +30073,10 @@
29100
30073
  "deploymentType": {
29101
30074
  "type": "string",
29102
30075
  "enum": [
29103
- "all",
30076
+ "production",
29104
30077
  "preview",
29105
- "prod_deployment_urls_and_all_previews",
29106
- "production"
30078
+ "all",
30079
+ "prod_deployment_urls_and_all_previews"
29107
30080
  ]
29108
30081
  }
29109
30082
  },
@@ -29988,10 +30961,10 @@
29988
30961
  "type": "string",
29989
30962
  "enum": [
29990
30963
  "system",
30964
+ "secret",
29991
30965
  "encrypted",
29992
30966
  "plain",
29993
- "sensitive",
29994
- "secret"
30967
+ "sensitive"
29995
30968
  ]
29996
30969
  },
29997
30970
  "sunsetSecretId": {
@@ -30371,7 +31344,161 @@
30371
31344
  },
30372
31345
  "customEnvironments": {
30373
31346
  "items": {
30374
- "type": "object"
31347
+ "properties": {
31348
+ "id": {
31349
+ "type": "string",
31350
+ "description": "Unique identifier for the custom environment (format: env_*)"
31351
+ },
31352
+ "slug": {
31353
+ "type": "string",
31354
+ "description": "URL-friendly name of the environment"
31355
+ },
31356
+ "type": {
31357
+ "type": "string",
31358
+ "enum": [
31359
+ "production",
31360
+ "preview",
31361
+ "development"
31362
+ ],
31363
+ "description": "The type of environment (production, preview, or development)"
31364
+ },
31365
+ "description": {
31366
+ "type": "string",
31367
+ "description": "Optional description of the environment's purpose"
31368
+ },
31369
+ "branchMatcher": {
31370
+ "properties": {
31371
+ "type": {
31372
+ "type": "string",
31373
+ "enum": [
31374
+ "endsWith",
31375
+ "startsWith",
31376
+ "equals"
31377
+ ],
31378
+ "description": "The type of matching to perform"
31379
+ },
31380
+ "pattern": {
31381
+ "type": "string",
31382
+ "description": "The pattern to match against branch names"
31383
+ }
31384
+ },
31385
+ "required": [
31386
+ "type",
31387
+ "pattern"
31388
+ ],
31389
+ "type": "object",
31390
+ "description": "Configuration for matching git branches to this environment"
31391
+ },
31392
+ "domains": {
31393
+ "items": {
31394
+ "properties": {
31395
+ "name": {
31396
+ "type": "string"
31397
+ },
31398
+ "apexName": {
31399
+ "type": "string"
31400
+ },
31401
+ "projectId": {
31402
+ "type": "string"
31403
+ },
31404
+ "redirect": {
31405
+ "nullable": true,
31406
+ "type": "string"
31407
+ },
31408
+ "redirectStatusCode": {
31409
+ "nullable": true,
31410
+ "type": "number",
31411
+ "enum": [
31412
+ 307,
31413
+ 301,
31414
+ 302,
31415
+ 308
31416
+ ]
31417
+ },
31418
+ "gitBranch": {
31419
+ "nullable": true,
31420
+ "type": "string"
31421
+ },
31422
+ "customEnvironmentId": {
31423
+ "nullable": true,
31424
+ "type": "string"
31425
+ },
31426
+ "updatedAt": {
31427
+ "type": "number"
31428
+ },
31429
+ "createdAt": {
31430
+ "type": "number"
31431
+ },
31432
+ "verified": {
31433
+ "type": "boolean",
31434
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
31435
+ },
31436
+ "verification": {
31437
+ "items": {
31438
+ "properties": {
31439
+ "type": {
31440
+ "type": "string"
31441
+ },
31442
+ "domain": {
31443
+ "type": "string"
31444
+ },
31445
+ "value": {
31446
+ "type": "string"
31447
+ },
31448
+ "reason": {
31449
+ "type": "string"
31450
+ }
31451
+ },
31452
+ "required": [
31453
+ "type",
31454
+ "domain",
31455
+ "value",
31456
+ "reason"
31457
+ ],
31458
+ "type": "object",
31459
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
31460
+ },
31461
+ "type": "array",
31462
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
31463
+ }
31464
+ },
31465
+ "required": [
31466
+ "name",
31467
+ "apexName",
31468
+ "projectId",
31469
+ "verified"
31470
+ ],
31471
+ "type": "object",
31472
+ "description": "List of domains associated with this environment"
31473
+ },
31474
+ "type": "array",
31475
+ "description": "List of domains associated with this environment"
31476
+ },
31477
+ "currentDeploymentAliases": {
31478
+ "items": {
31479
+ "type": "string"
31480
+ },
31481
+ "type": "array",
31482
+ "description": "List of aliases for the current deployment"
31483
+ },
31484
+ "createdAt": {
31485
+ "type": "number",
31486
+ "description": "Timestamp when the environment was created"
31487
+ },
31488
+ "updatedAt": {
31489
+ "type": "number",
31490
+ "description": "Timestamp when the environment was last updated"
31491
+ }
31492
+ },
31493
+ "required": [
31494
+ "id",
31495
+ "slug",
31496
+ "type",
31497
+ "createdAt",
31498
+ "updatedAt"
31499
+ ],
31500
+ "type": "object",
31501
+ "description": "Internal representation of a custom environment with all required properties"
30375
31502
  },
30376
31503
  "type": "array"
30377
31504
  },
@@ -31340,8 +32467,8 @@
31340
32467
  "deploymentType": {
31341
32468
  "type": "string",
31342
32469
  "enum": [
31343
- "all",
31344
32470
  "preview",
32471
+ "all",
31345
32472
  "prod_deployment_urls_and_all_previews"
31346
32473
  ]
31347
32474
  }
@@ -32863,6 +33990,10 @@
32863
33990
  "toDeploymentId": {
32864
33991
  "type": "string"
32865
33992
  },
33993
+ "fromRollingReleaseId": {
33994
+ "type": "string",
33995
+ "description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
33996
+ },
32866
33997
  "jobStatus": {
32867
33998
  "type": "string",
32868
33999
  "enum": [
@@ -32929,10 +34060,10 @@
32929
34060
  "deploymentType": {
32930
34061
  "type": "string",
32931
34062
  "enum": [
32932
- "all",
34063
+ "production",
32933
34064
  "preview",
32934
- "prod_deployment_urls_and_all_previews",
32935
- "production"
34065
+ "all",
34066
+ "prod_deployment_urls_and_all_previews"
32936
34067
  ]
32937
34068
  },
32938
34069
  "addresses": {
@@ -32972,10 +34103,10 @@
32972
34103
  "deploymentType": {
32973
34104
  "type": "string",
32974
34105
  "enum": [
32975
- "all",
34106
+ "production",
32976
34107
  "preview",
32977
- "prod_deployment_urls_and_all_previews",
32978
- "production"
34108
+ "all",
34109
+ "prod_deployment_urls_and_all_previews"
32979
34110
  ]
32980
34111
  }
32981
34112
  },
@@ -33129,8 +34260,8 @@
33129
34260
  "type": {
33130
34261
  "type": "string",
33131
34262
  "enum": [
33132
- "path",
33133
34263
  "host",
34264
+ "path",
33134
34265
  "method",
33135
34266
  "header",
33136
34267
  "cookie",
@@ -33211,8 +34342,8 @@
33211
34342
  "type": {
33212
34343
  "type": "string",
33213
34344
  "enum": [
33214
- "path",
33215
34345
  "host",
34346
+ "path",
33216
34347
  "method",
33217
34348
  "header",
33218
34349
  "cookie",
@@ -33500,6 +34631,16 @@
33500
34631
  "schema": {
33501
34632
  "additionalProperties": false,
33502
34633
  "properties": {
34634
+ "enablePreviewFeedback": {
34635
+ "description": "Opt-in to preview toolbar on the project level",
34636
+ "type": "boolean",
34637
+ "nullable": true
34638
+ },
34639
+ "enableProductionFeedback": {
34640
+ "description": "Opt-in to production toolbar on the project level",
34641
+ "type": "boolean",
34642
+ "nullable": true
34643
+ },
33503
34644
  "buildCommand": {
33504
34645
  "description": "The build command for this project. When `null` is used this value will be automatically detected",
33505
34646
  "maxLength": 256,
@@ -34370,7 +35511,161 @@
34370
35511
  },
34371
35512
  "customEnvironments": {
34372
35513
  "items": {
34373
- "type": "object"
35514
+ "properties": {
35515
+ "id": {
35516
+ "type": "string",
35517
+ "description": "Unique identifier for the custom environment (format: env_*)"
35518
+ },
35519
+ "slug": {
35520
+ "type": "string",
35521
+ "description": "URL-friendly name of the environment"
35522
+ },
35523
+ "type": {
35524
+ "type": "string",
35525
+ "enum": [
35526
+ "production",
35527
+ "preview",
35528
+ "development"
35529
+ ],
35530
+ "description": "The type of environment (production, preview, or development)"
35531
+ },
35532
+ "description": {
35533
+ "type": "string",
35534
+ "description": "Optional description of the environment's purpose"
35535
+ },
35536
+ "branchMatcher": {
35537
+ "properties": {
35538
+ "type": {
35539
+ "type": "string",
35540
+ "enum": [
35541
+ "endsWith",
35542
+ "startsWith",
35543
+ "equals"
35544
+ ],
35545
+ "description": "The type of matching to perform"
35546
+ },
35547
+ "pattern": {
35548
+ "type": "string",
35549
+ "description": "The pattern to match against branch names"
35550
+ }
35551
+ },
35552
+ "required": [
35553
+ "type",
35554
+ "pattern"
35555
+ ],
35556
+ "type": "object",
35557
+ "description": "Configuration for matching git branches to this environment"
35558
+ },
35559
+ "domains": {
35560
+ "items": {
35561
+ "properties": {
35562
+ "name": {
35563
+ "type": "string"
35564
+ },
35565
+ "apexName": {
35566
+ "type": "string"
35567
+ },
35568
+ "projectId": {
35569
+ "type": "string"
35570
+ },
35571
+ "redirect": {
35572
+ "nullable": true,
35573
+ "type": "string"
35574
+ },
35575
+ "redirectStatusCode": {
35576
+ "nullable": true,
35577
+ "type": "number",
35578
+ "enum": [
35579
+ 307,
35580
+ 301,
35581
+ 302,
35582
+ 308
35583
+ ]
35584
+ },
35585
+ "gitBranch": {
35586
+ "nullable": true,
35587
+ "type": "string"
35588
+ },
35589
+ "customEnvironmentId": {
35590
+ "nullable": true,
35591
+ "type": "string"
35592
+ },
35593
+ "updatedAt": {
35594
+ "type": "number"
35595
+ },
35596
+ "createdAt": {
35597
+ "type": "number"
35598
+ },
35599
+ "verified": {
35600
+ "type": "boolean",
35601
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
35602
+ },
35603
+ "verification": {
35604
+ "items": {
35605
+ "properties": {
35606
+ "type": {
35607
+ "type": "string"
35608
+ },
35609
+ "domain": {
35610
+ "type": "string"
35611
+ },
35612
+ "value": {
35613
+ "type": "string"
35614
+ },
35615
+ "reason": {
35616
+ "type": "string"
35617
+ }
35618
+ },
35619
+ "required": [
35620
+ "type",
35621
+ "domain",
35622
+ "value",
35623
+ "reason"
35624
+ ],
35625
+ "type": "object",
35626
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
35627
+ },
35628
+ "type": "array",
35629
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
35630
+ }
35631
+ },
35632
+ "required": [
35633
+ "name",
35634
+ "apexName",
35635
+ "projectId",
35636
+ "verified"
35637
+ ],
35638
+ "type": "object",
35639
+ "description": "List of domains associated with this environment"
35640
+ },
35641
+ "type": "array",
35642
+ "description": "List of domains associated with this environment"
35643
+ },
35644
+ "currentDeploymentAliases": {
35645
+ "items": {
35646
+ "type": "string"
35647
+ },
35648
+ "type": "array",
35649
+ "description": "List of aliases for the current deployment"
35650
+ },
35651
+ "createdAt": {
35652
+ "type": "number",
35653
+ "description": "Timestamp when the environment was created"
35654
+ },
35655
+ "updatedAt": {
35656
+ "type": "number",
35657
+ "description": "Timestamp when the environment was last updated"
35658
+ }
35659
+ },
35660
+ "required": [
35661
+ "id",
35662
+ "slug",
35663
+ "type",
35664
+ "createdAt",
35665
+ "updatedAt"
35666
+ ],
35667
+ "type": "object",
35668
+ "description": "Internal representation of a custom environment with all required properties"
34374
35669
  },
34375
35670
  "type": "array"
34376
35671
  },
@@ -35339,8 +36634,8 @@
35339
36634
  "deploymentType": {
35340
36635
  "type": "string",
35341
36636
  "enum": [
35342
- "all",
35343
36637
  "preview",
36638
+ "all",
35344
36639
  "prod_deployment_urls_and_all_previews"
35345
36640
  ]
35346
36641
  }
@@ -36862,6 +38157,10 @@
36862
38157
  "toDeploymentId": {
36863
38158
  "type": "string"
36864
38159
  },
38160
+ "fromRollingReleaseId": {
38161
+ "type": "string",
38162
+ "description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
38163
+ },
36865
38164
  "jobStatus": {
36866
38165
  "type": "string",
36867
38166
  "enum": [
@@ -36928,10 +38227,10 @@
36928
38227
  "deploymentType": {
36929
38228
  "type": "string",
36930
38229
  "enum": [
36931
- "all",
38230
+ "production",
36932
38231
  "preview",
36933
- "prod_deployment_urls_and_all_previews",
36934
- "production"
38232
+ "all",
38233
+ "prod_deployment_urls_and_all_previews"
36935
38234
  ]
36936
38235
  },
36937
38236
  "addresses": {
@@ -36971,10 +38270,10 @@
36971
38270
  "deploymentType": {
36972
38271
  "type": "string",
36973
38272
  "enum": [
36974
- "all",
38273
+ "production",
36975
38274
  "preview",
36976
- "prod_deployment_urls_and_all_previews",
36977
- "production"
38275
+ "all",
38276
+ "prod_deployment_urls_and_all_previews"
36978
38277
  ]
36979
38278
  }
36980
38279
  },
@@ -37749,10 +39048,10 @@
37749
39048
  "type": "string",
37750
39049
  "enum": [
37751
39050
  "system",
39051
+ "secret",
37752
39052
  "encrypted",
37753
39053
  "plain",
37754
- "sensitive",
37755
- "secret"
39054
+ "sensitive"
37756
39055
  ]
37757
39056
  },
37758
39057
  "sunsetSecretId": {
@@ -38132,7 +39431,161 @@
38132
39431
  },
38133
39432
  "customEnvironments": {
38134
39433
  "items": {
38135
- "type": "object"
39434
+ "properties": {
39435
+ "id": {
39436
+ "type": "string",
39437
+ "description": "Unique identifier for the custom environment (format: env_*)"
39438
+ },
39439
+ "slug": {
39440
+ "type": "string",
39441
+ "description": "URL-friendly name of the environment"
39442
+ },
39443
+ "type": {
39444
+ "type": "string",
39445
+ "enum": [
39446
+ "production",
39447
+ "preview",
39448
+ "development"
39449
+ ],
39450
+ "description": "The type of environment (production, preview, or development)"
39451
+ },
39452
+ "description": {
39453
+ "type": "string",
39454
+ "description": "Optional description of the environment's purpose"
39455
+ },
39456
+ "branchMatcher": {
39457
+ "properties": {
39458
+ "type": {
39459
+ "type": "string",
39460
+ "enum": [
39461
+ "endsWith",
39462
+ "startsWith",
39463
+ "equals"
39464
+ ],
39465
+ "description": "The type of matching to perform"
39466
+ },
39467
+ "pattern": {
39468
+ "type": "string",
39469
+ "description": "The pattern to match against branch names"
39470
+ }
39471
+ },
39472
+ "required": [
39473
+ "type",
39474
+ "pattern"
39475
+ ],
39476
+ "type": "object",
39477
+ "description": "Configuration for matching git branches to this environment"
39478
+ },
39479
+ "domains": {
39480
+ "items": {
39481
+ "properties": {
39482
+ "name": {
39483
+ "type": "string"
39484
+ },
39485
+ "apexName": {
39486
+ "type": "string"
39487
+ },
39488
+ "projectId": {
39489
+ "type": "string"
39490
+ },
39491
+ "redirect": {
39492
+ "nullable": true,
39493
+ "type": "string"
39494
+ },
39495
+ "redirectStatusCode": {
39496
+ "nullable": true,
39497
+ "type": "number",
39498
+ "enum": [
39499
+ 307,
39500
+ 301,
39501
+ 302,
39502
+ 308
39503
+ ]
39504
+ },
39505
+ "gitBranch": {
39506
+ "nullable": true,
39507
+ "type": "string"
39508
+ },
39509
+ "customEnvironmentId": {
39510
+ "nullable": true,
39511
+ "type": "string"
39512
+ },
39513
+ "updatedAt": {
39514
+ "type": "number"
39515
+ },
39516
+ "createdAt": {
39517
+ "type": "number"
39518
+ },
39519
+ "verified": {
39520
+ "type": "boolean",
39521
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
39522
+ },
39523
+ "verification": {
39524
+ "items": {
39525
+ "properties": {
39526
+ "type": {
39527
+ "type": "string"
39528
+ },
39529
+ "domain": {
39530
+ "type": "string"
39531
+ },
39532
+ "value": {
39533
+ "type": "string"
39534
+ },
39535
+ "reason": {
39536
+ "type": "string"
39537
+ }
39538
+ },
39539
+ "required": [
39540
+ "type",
39541
+ "domain",
39542
+ "value",
39543
+ "reason"
39544
+ ],
39545
+ "type": "object",
39546
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
39547
+ },
39548
+ "type": "array",
39549
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
39550
+ }
39551
+ },
39552
+ "required": [
39553
+ "name",
39554
+ "apexName",
39555
+ "projectId",
39556
+ "verified"
39557
+ ],
39558
+ "type": "object",
39559
+ "description": "List of domains associated with this environment"
39560
+ },
39561
+ "type": "array",
39562
+ "description": "List of domains associated with this environment"
39563
+ },
39564
+ "currentDeploymentAliases": {
39565
+ "items": {
39566
+ "type": "string"
39567
+ },
39568
+ "type": "array",
39569
+ "description": "List of aliases for the current deployment"
39570
+ },
39571
+ "createdAt": {
39572
+ "type": "number",
39573
+ "description": "Timestamp when the environment was created"
39574
+ },
39575
+ "updatedAt": {
39576
+ "type": "number",
39577
+ "description": "Timestamp when the environment was last updated"
39578
+ }
39579
+ },
39580
+ "required": [
39581
+ "id",
39582
+ "slug",
39583
+ "type",
39584
+ "createdAt",
39585
+ "updatedAt"
39586
+ ],
39587
+ "type": "object",
39588
+ "description": "Internal representation of a custom environment with all required properties"
38136
39589
  },
38137
39590
  "type": "array"
38138
39591
  },
@@ -39101,8 +40554,8 @@
39101
40554
  "deploymentType": {
39102
40555
  "type": "string",
39103
40556
  "enum": [
39104
- "all",
39105
40557
  "preview",
40558
+ "all",
39106
40559
  "prod_deployment_urls_and_all_previews"
39107
40560
  ]
39108
40561
  }
@@ -40624,6 +42077,10 @@
40624
42077
  "toDeploymentId": {
40625
42078
  "type": "string"
40626
42079
  },
42080
+ "fromRollingReleaseId": {
42081
+ "type": "string",
42082
+ "description": "If rolling back from a rolling release, fromDeploymentId captures the \"base\" of that rolling release, and fromRollingReleaseId captures the \"target\" of that rolling release."
42083
+ },
40627
42084
  "jobStatus": {
40628
42085
  "type": "string",
40629
42086
  "enum": [
@@ -40690,10 +42147,10 @@
40690
42147
  "deploymentType": {
40691
42148
  "type": "string",
40692
42149
  "enum": [
40693
- "all",
42150
+ "production",
40694
42151
  "preview",
40695
- "prod_deployment_urls_and_all_previews",
40696
- "production"
42152
+ "all",
42153
+ "prod_deployment_urls_and_all_previews"
40697
42154
  ]
40698
42155
  },
40699
42156
  "addresses": {
@@ -40733,10 +42190,10 @@
40733
42190
  "deploymentType": {
40734
42191
  "type": "string",
40735
42192
  "enum": [
40736
- "all",
42193
+ "production",
40737
42194
  "preview",
40738
- "prod_deployment_urls_and_all_previews",
40739
- "production"
42195
+ "all",
42196
+ "prod_deployment_urls_and_all_previews"
40740
42197
  ]
40741
42198
  }
40742
42199
  },
@@ -40890,8 +42347,8 @@
40890
42347
  "type": {
40891
42348
  "type": "string",
40892
42349
  "enum": [
40893
- "path",
40894
42350
  "host",
42351
+ "path",
40895
42352
  "method",
40896
42353
  "header",
40897
42354
  "cookie",
@@ -40972,8 +42429,8 @@
40972
42429
  "type": {
40973
42430
  "type": "string",
40974
42431
  "enum": [
40975
- "path",
40976
42432
  "host",
42433
+ "path",
40977
42434
  "method",
40978
42435
  "header",
40979
42436
  "cookie",
@@ -41623,6 +43080,44 @@
41623
43080
  ],
41624
43081
  "type": "object",
41625
43082
  "nullable": true
43083
+ },
43084
+ "connectConfigurations": {
43085
+ "type": "array",
43086
+ "description": "The list of connections from project environment to Secure Compute network",
43087
+ "items": {
43088
+ "additionalProperties": false,
43089
+ "properties": {
43090
+ "envId": {
43091
+ "type": "string",
43092
+ "description": "The ID of the environment"
43093
+ },
43094
+ "connectConfigurationId": {
43095
+ "type": "string",
43096
+ "description": "The ID of the Secure Compute network"
43097
+ },
43098
+ "passive": {
43099
+ "type": "boolean",
43100
+ "description": "Whether the configuration should be passive, meaning builds will not run there and only passive Serverless Functions will be deployed"
43101
+ },
43102
+ "buildsEnabled": {
43103
+ "type": "boolean",
43104
+ "description": "Flag saying if project builds should use Secure Compute"
43105
+ }
43106
+ },
43107
+ "required": [
43108
+ "envId",
43109
+ "connectConfigurationId",
43110
+ "passive",
43111
+ "buildsEnabled"
43112
+ ],
43113
+ "oneOf": [
43114
+ {
43115
+ "type": "object"
43116
+ }
43117
+ ]
43118
+ },
43119
+ "minItems": 1,
43120
+ "nullable": true
41626
43121
  }
41627
43122
  },
41628
43123
  "type": "object"
@@ -41732,7 +43227,161 @@
41732
43227
  "content": {
41733
43228
  "application/json": {
41734
43229
  "schema": {
41735
- "type": "object"
43230
+ "properties": {
43231
+ "id": {
43232
+ "type": "string",
43233
+ "description": "Unique identifier for the custom environment (format: env_*)"
43234
+ },
43235
+ "slug": {
43236
+ "type": "string",
43237
+ "description": "URL-friendly name of the environment"
43238
+ },
43239
+ "type": {
43240
+ "type": "string",
43241
+ "enum": [
43242
+ "production",
43243
+ "preview",
43244
+ "development"
43245
+ ],
43246
+ "description": "The type of environment (production, preview, or development)"
43247
+ },
43248
+ "description": {
43249
+ "type": "string",
43250
+ "description": "Optional description of the environment's purpose"
43251
+ },
43252
+ "branchMatcher": {
43253
+ "properties": {
43254
+ "type": {
43255
+ "type": "string",
43256
+ "enum": [
43257
+ "endsWith",
43258
+ "startsWith",
43259
+ "equals"
43260
+ ],
43261
+ "description": "The type of matching to perform"
43262
+ },
43263
+ "pattern": {
43264
+ "type": "string",
43265
+ "description": "The pattern to match against branch names"
43266
+ }
43267
+ },
43268
+ "required": [
43269
+ "type",
43270
+ "pattern"
43271
+ ],
43272
+ "type": "object",
43273
+ "description": "Configuration for matching git branches to this environment"
43274
+ },
43275
+ "domains": {
43276
+ "items": {
43277
+ "properties": {
43278
+ "name": {
43279
+ "type": "string"
43280
+ },
43281
+ "apexName": {
43282
+ "type": "string"
43283
+ },
43284
+ "projectId": {
43285
+ "type": "string"
43286
+ },
43287
+ "redirect": {
43288
+ "nullable": true,
43289
+ "type": "string"
43290
+ },
43291
+ "redirectStatusCode": {
43292
+ "nullable": true,
43293
+ "type": "number",
43294
+ "enum": [
43295
+ 307,
43296
+ 301,
43297
+ 302,
43298
+ 308
43299
+ ]
43300
+ },
43301
+ "gitBranch": {
43302
+ "nullable": true,
43303
+ "type": "string"
43304
+ },
43305
+ "customEnvironmentId": {
43306
+ "nullable": true,
43307
+ "type": "string"
43308
+ },
43309
+ "updatedAt": {
43310
+ "type": "number"
43311
+ },
43312
+ "createdAt": {
43313
+ "type": "number"
43314
+ },
43315
+ "verified": {
43316
+ "type": "boolean",
43317
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
43318
+ },
43319
+ "verification": {
43320
+ "items": {
43321
+ "properties": {
43322
+ "type": {
43323
+ "type": "string"
43324
+ },
43325
+ "domain": {
43326
+ "type": "string"
43327
+ },
43328
+ "value": {
43329
+ "type": "string"
43330
+ },
43331
+ "reason": {
43332
+ "type": "string"
43333
+ }
43334
+ },
43335
+ "required": [
43336
+ "type",
43337
+ "domain",
43338
+ "value",
43339
+ "reason"
43340
+ ],
43341
+ "type": "object",
43342
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43343
+ },
43344
+ "type": "array",
43345
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43346
+ }
43347
+ },
43348
+ "required": [
43349
+ "name",
43350
+ "apexName",
43351
+ "projectId",
43352
+ "verified"
43353
+ ],
43354
+ "type": "object",
43355
+ "description": "List of domains associated with this environment"
43356
+ },
43357
+ "type": "array",
43358
+ "description": "List of domains associated with this environment"
43359
+ },
43360
+ "currentDeploymentAliases": {
43361
+ "items": {
43362
+ "type": "string"
43363
+ },
43364
+ "type": "array",
43365
+ "description": "List of aliases for the current deployment"
43366
+ },
43367
+ "createdAt": {
43368
+ "type": "number",
43369
+ "description": "Timestamp when the environment was created"
43370
+ },
43371
+ "updatedAt": {
43372
+ "type": "number",
43373
+ "description": "Timestamp when the environment was last updated"
43374
+ }
43375
+ },
43376
+ "required": [
43377
+ "id",
43378
+ "slug",
43379
+ "type",
43380
+ "createdAt",
43381
+ "updatedAt"
43382
+ ],
43383
+ "type": "object",
43384
+ "description": "Internal representation of a custom environment with all required properties"
41736
43385
  }
41737
43386
  }
41738
43387
  }
@@ -41878,6 +43527,159 @@
41878
43527
  },
41879
43528
  "environments": {
41880
43529
  "items": {
43530
+ "properties": {
43531
+ "id": {
43532
+ "type": "string",
43533
+ "description": "Unique identifier for the custom environment (format: env_*)"
43534
+ },
43535
+ "slug": {
43536
+ "type": "string",
43537
+ "description": "URL-friendly name of the environment"
43538
+ },
43539
+ "type": {
43540
+ "type": "string",
43541
+ "enum": [
43542
+ "production",
43543
+ "preview",
43544
+ "development"
43545
+ ],
43546
+ "description": "The type of environment (production, preview, or development)"
43547
+ },
43548
+ "description": {
43549
+ "type": "string",
43550
+ "description": "Optional description of the environment's purpose"
43551
+ },
43552
+ "branchMatcher": {
43553
+ "properties": {
43554
+ "type": {
43555
+ "type": "string",
43556
+ "enum": [
43557
+ "endsWith",
43558
+ "startsWith",
43559
+ "equals"
43560
+ ],
43561
+ "description": "The type of matching to perform"
43562
+ },
43563
+ "pattern": {
43564
+ "type": "string",
43565
+ "description": "The pattern to match against branch names"
43566
+ }
43567
+ },
43568
+ "required": [
43569
+ "type",
43570
+ "pattern"
43571
+ ],
43572
+ "type": "object",
43573
+ "description": "Configuration for matching git branches to this environment"
43574
+ },
43575
+ "domains": {
43576
+ "items": {
43577
+ "properties": {
43578
+ "name": {
43579
+ "type": "string"
43580
+ },
43581
+ "apexName": {
43582
+ "type": "string"
43583
+ },
43584
+ "projectId": {
43585
+ "type": "string"
43586
+ },
43587
+ "redirect": {
43588
+ "nullable": true,
43589
+ "type": "string"
43590
+ },
43591
+ "redirectStatusCode": {
43592
+ "nullable": true,
43593
+ "type": "number",
43594
+ "enum": [
43595
+ 307,
43596
+ 301,
43597
+ 302,
43598
+ 308
43599
+ ]
43600
+ },
43601
+ "gitBranch": {
43602
+ "nullable": true,
43603
+ "type": "string"
43604
+ },
43605
+ "customEnvironmentId": {
43606
+ "nullable": true,
43607
+ "type": "string"
43608
+ },
43609
+ "updatedAt": {
43610
+ "type": "number"
43611
+ },
43612
+ "createdAt": {
43613
+ "type": "number"
43614
+ },
43615
+ "verified": {
43616
+ "type": "boolean",
43617
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
43618
+ },
43619
+ "verification": {
43620
+ "items": {
43621
+ "properties": {
43622
+ "type": {
43623
+ "type": "string"
43624
+ },
43625
+ "domain": {
43626
+ "type": "string"
43627
+ },
43628
+ "value": {
43629
+ "type": "string"
43630
+ },
43631
+ "reason": {
43632
+ "type": "string"
43633
+ }
43634
+ },
43635
+ "required": [
43636
+ "type",
43637
+ "domain",
43638
+ "value",
43639
+ "reason"
43640
+ ],
43641
+ "type": "object",
43642
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43643
+ },
43644
+ "type": "array",
43645
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43646
+ }
43647
+ },
43648
+ "required": [
43649
+ "name",
43650
+ "apexName",
43651
+ "projectId",
43652
+ "verified"
43653
+ ],
43654
+ "type": "object",
43655
+ "description": "List of domains associated with this environment"
43656
+ },
43657
+ "type": "array",
43658
+ "description": "List of domains associated with this environment"
43659
+ },
43660
+ "currentDeploymentAliases": {
43661
+ "items": {
43662
+ "type": "string"
43663
+ },
43664
+ "type": "array",
43665
+ "description": "List of aliases for the current deployment"
43666
+ },
43667
+ "createdAt": {
43668
+ "type": "number",
43669
+ "description": "Timestamp when the environment was created"
43670
+ },
43671
+ "updatedAt": {
43672
+ "type": "number",
43673
+ "description": "Timestamp when the environment was last updated"
43674
+ }
43675
+ },
43676
+ "required": [
43677
+ "id",
43678
+ "slug",
43679
+ "type",
43680
+ "createdAt",
43681
+ "updatedAt"
43682
+ ],
41881
43683
  "type": "object"
41882
43684
  },
41883
43685
  "type": "array"
@@ -41977,6 +43779,159 @@
41977
43779
  "content": {
41978
43780
  "application/json": {
41979
43781
  "schema": {
43782
+ "properties": {
43783
+ "id": {
43784
+ "type": "string",
43785
+ "description": "Unique identifier for the custom environment (format: env_*)"
43786
+ },
43787
+ "slug": {
43788
+ "type": "string",
43789
+ "description": "URL-friendly name of the environment"
43790
+ },
43791
+ "type": {
43792
+ "type": "string",
43793
+ "enum": [
43794
+ "production",
43795
+ "preview",
43796
+ "development"
43797
+ ],
43798
+ "description": "The type of environment (production, preview, or development)"
43799
+ },
43800
+ "description": {
43801
+ "type": "string",
43802
+ "description": "Optional description of the environment's purpose"
43803
+ },
43804
+ "branchMatcher": {
43805
+ "properties": {
43806
+ "type": {
43807
+ "type": "string",
43808
+ "enum": [
43809
+ "endsWith",
43810
+ "startsWith",
43811
+ "equals"
43812
+ ],
43813
+ "description": "The type of matching to perform"
43814
+ },
43815
+ "pattern": {
43816
+ "type": "string",
43817
+ "description": "The pattern to match against branch names"
43818
+ }
43819
+ },
43820
+ "required": [
43821
+ "type",
43822
+ "pattern"
43823
+ ],
43824
+ "type": "object",
43825
+ "description": "Configuration for matching git branches to this environment"
43826
+ },
43827
+ "domains": {
43828
+ "items": {
43829
+ "properties": {
43830
+ "name": {
43831
+ "type": "string"
43832
+ },
43833
+ "apexName": {
43834
+ "type": "string"
43835
+ },
43836
+ "projectId": {
43837
+ "type": "string"
43838
+ },
43839
+ "redirect": {
43840
+ "nullable": true,
43841
+ "type": "string"
43842
+ },
43843
+ "redirectStatusCode": {
43844
+ "nullable": true,
43845
+ "type": "number",
43846
+ "enum": [
43847
+ 307,
43848
+ 301,
43849
+ 302,
43850
+ 308
43851
+ ]
43852
+ },
43853
+ "gitBranch": {
43854
+ "nullable": true,
43855
+ "type": "string"
43856
+ },
43857
+ "customEnvironmentId": {
43858
+ "nullable": true,
43859
+ "type": "string"
43860
+ },
43861
+ "updatedAt": {
43862
+ "type": "number"
43863
+ },
43864
+ "createdAt": {
43865
+ "type": "number"
43866
+ },
43867
+ "verified": {
43868
+ "type": "boolean",
43869
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
43870
+ },
43871
+ "verification": {
43872
+ "items": {
43873
+ "properties": {
43874
+ "type": {
43875
+ "type": "string"
43876
+ },
43877
+ "domain": {
43878
+ "type": "string"
43879
+ },
43880
+ "value": {
43881
+ "type": "string"
43882
+ },
43883
+ "reason": {
43884
+ "type": "string"
43885
+ }
43886
+ },
43887
+ "required": [
43888
+ "type",
43889
+ "domain",
43890
+ "value",
43891
+ "reason"
43892
+ ],
43893
+ "type": "object",
43894
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43895
+ },
43896
+ "type": "array",
43897
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
43898
+ }
43899
+ },
43900
+ "required": [
43901
+ "name",
43902
+ "apexName",
43903
+ "projectId",
43904
+ "verified"
43905
+ ],
43906
+ "type": "object",
43907
+ "description": "List of domains associated with this environment"
43908
+ },
43909
+ "type": "array",
43910
+ "description": "List of domains associated with this environment"
43911
+ },
43912
+ "currentDeploymentAliases": {
43913
+ "items": {
43914
+ "type": "string"
43915
+ },
43916
+ "type": "array",
43917
+ "description": "List of aliases for the current deployment"
43918
+ },
43919
+ "createdAt": {
43920
+ "type": "number",
43921
+ "description": "Timestamp when the environment was created"
43922
+ },
43923
+ "updatedAt": {
43924
+ "type": "number",
43925
+ "description": "Timestamp when the environment was last updated"
43926
+ }
43927
+ },
43928
+ "required": [
43929
+ "id",
43930
+ "slug",
43931
+ "type",
43932
+ "createdAt",
43933
+ "updatedAt"
43934
+ ],
41980
43935
  "type": "object",
41981
43936
  "description": "Internal representation of a custom environment with all required properties"
41982
43937
  }
@@ -42076,7 +44031,161 @@
42076
44031
  "content": {
42077
44032
  "application/json": {
42078
44033
  "schema": {
42079
- "type": "object"
44034
+ "properties": {
44035
+ "id": {
44036
+ "type": "string",
44037
+ "description": "Unique identifier for the custom environment (format: env_*)"
44038
+ },
44039
+ "slug": {
44040
+ "type": "string",
44041
+ "description": "URL-friendly name of the environment"
44042
+ },
44043
+ "type": {
44044
+ "type": "string",
44045
+ "enum": [
44046
+ "production",
44047
+ "preview",
44048
+ "development"
44049
+ ],
44050
+ "description": "The type of environment (production, preview, or development)"
44051
+ },
44052
+ "description": {
44053
+ "type": "string",
44054
+ "description": "Optional description of the environment's purpose"
44055
+ },
44056
+ "branchMatcher": {
44057
+ "properties": {
44058
+ "type": {
44059
+ "type": "string",
44060
+ "enum": [
44061
+ "endsWith",
44062
+ "startsWith",
44063
+ "equals"
44064
+ ],
44065
+ "description": "The type of matching to perform"
44066
+ },
44067
+ "pattern": {
44068
+ "type": "string",
44069
+ "description": "The pattern to match against branch names"
44070
+ }
44071
+ },
44072
+ "required": [
44073
+ "type",
44074
+ "pattern"
44075
+ ],
44076
+ "type": "object",
44077
+ "description": "Configuration for matching git branches to this environment"
44078
+ },
44079
+ "domains": {
44080
+ "items": {
44081
+ "properties": {
44082
+ "name": {
44083
+ "type": "string"
44084
+ },
44085
+ "apexName": {
44086
+ "type": "string"
44087
+ },
44088
+ "projectId": {
44089
+ "type": "string"
44090
+ },
44091
+ "redirect": {
44092
+ "nullable": true,
44093
+ "type": "string"
44094
+ },
44095
+ "redirectStatusCode": {
44096
+ "nullable": true,
44097
+ "type": "number",
44098
+ "enum": [
44099
+ 307,
44100
+ 301,
44101
+ 302,
44102
+ 308
44103
+ ]
44104
+ },
44105
+ "gitBranch": {
44106
+ "nullable": true,
44107
+ "type": "string"
44108
+ },
44109
+ "customEnvironmentId": {
44110
+ "nullable": true,
44111
+ "type": "string"
44112
+ },
44113
+ "updatedAt": {
44114
+ "type": "number"
44115
+ },
44116
+ "createdAt": {
44117
+ "type": "number"
44118
+ },
44119
+ "verified": {
44120
+ "type": "boolean",
44121
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
44122
+ },
44123
+ "verification": {
44124
+ "items": {
44125
+ "properties": {
44126
+ "type": {
44127
+ "type": "string"
44128
+ },
44129
+ "domain": {
44130
+ "type": "string"
44131
+ },
44132
+ "value": {
44133
+ "type": "string"
44134
+ },
44135
+ "reason": {
44136
+ "type": "string"
44137
+ }
44138
+ },
44139
+ "required": [
44140
+ "type",
44141
+ "domain",
44142
+ "value",
44143
+ "reason"
44144
+ ],
44145
+ "type": "object",
44146
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
44147
+ },
44148
+ "type": "array",
44149
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
44150
+ }
44151
+ },
44152
+ "required": [
44153
+ "name",
44154
+ "apexName",
44155
+ "projectId",
44156
+ "verified"
44157
+ ],
44158
+ "type": "object",
44159
+ "description": "List of domains associated with this environment"
44160
+ },
44161
+ "type": "array",
44162
+ "description": "List of domains associated with this environment"
44163
+ },
44164
+ "currentDeploymentAliases": {
44165
+ "items": {
44166
+ "type": "string"
44167
+ },
44168
+ "type": "array",
44169
+ "description": "List of aliases for the current deployment"
44170
+ },
44171
+ "createdAt": {
44172
+ "type": "number",
44173
+ "description": "Timestamp when the environment was created"
44174
+ },
44175
+ "updatedAt": {
44176
+ "type": "number",
44177
+ "description": "Timestamp when the environment was last updated"
44178
+ }
44179
+ },
44180
+ "required": [
44181
+ "id",
44182
+ "slug",
44183
+ "type",
44184
+ "createdAt",
44185
+ "updatedAt"
44186
+ ],
44187
+ "type": "object",
44188
+ "description": "Internal representation of a custom environment with all required properties"
42080
44189
  }
42081
44190
  }
42082
44191
  }
@@ -42215,7 +44324,161 @@
42215
44324
  "content": {
42216
44325
  "application/json": {
42217
44326
  "schema": {
42218
- "type": "object"
44327
+ "properties": {
44328
+ "id": {
44329
+ "type": "string",
44330
+ "description": "Unique identifier for the custom environment (format: env_*)"
44331
+ },
44332
+ "slug": {
44333
+ "type": "string",
44334
+ "description": "URL-friendly name of the environment"
44335
+ },
44336
+ "type": {
44337
+ "type": "string",
44338
+ "enum": [
44339
+ "production",
44340
+ "preview",
44341
+ "development"
44342
+ ],
44343
+ "description": "The type of environment (production, preview, or development)"
44344
+ },
44345
+ "description": {
44346
+ "type": "string",
44347
+ "description": "Optional description of the environment's purpose"
44348
+ },
44349
+ "branchMatcher": {
44350
+ "properties": {
44351
+ "type": {
44352
+ "type": "string",
44353
+ "enum": [
44354
+ "endsWith",
44355
+ "startsWith",
44356
+ "equals"
44357
+ ],
44358
+ "description": "The type of matching to perform"
44359
+ },
44360
+ "pattern": {
44361
+ "type": "string",
44362
+ "description": "The pattern to match against branch names"
44363
+ }
44364
+ },
44365
+ "required": [
44366
+ "type",
44367
+ "pattern"
44368
+ ],
44369
+ "type": "object",
44370
+ "description": "Configuration for matching git branches to this environment"
44371
+ },
44372
+ "domains": {
44373
+ "items": {
44374
+ "properties": {
44375
+ "name": {
44376
+ "type": "string"
44377
+ },
44378
+ "apexName": {
44379
+ "type": "string"
44380
+ },
44381
+ "projectId": {
44382
+ "type": "string"
44383
+ },
44384
+ "redirect": {
44385
+ "nullable": true,
44386
+ "type": "string"
44387
+ },
44388
+ "redirectStatusCode": {
44389
+ "nullable": true,
44390
+ "type": "number",
44391
+ "enum": [
44392
+ 307,
44393
+ 301,
44394
+ 302,
44395
+ 308
44396
+ ]
44397
+ },
44398
+ "gitBranch": {
44399
+ "nullable": true,
44400
+ "type": "string"
44401
+ },
44402
+ "customEnvironmentId": {
44403
+ "nullable": true,
44404
+ "type": "string"
44405
+ },
44406
+ "updatedAt": {
44407
+ "type": "number"
44408
+ },
44409
+ "createdAt": {
44410
+ "type": "number"
44411
+ },
44412
+ "verified": {
44413
+ "type": "boolean",
44414
+ "description": "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed."
44415
+ },
44416
+ "verification": {
44417
+ "items": {
44418
+ "properties": {
44419
+ "type": {
44420
+ "type": "string"
44421
+ },
44422
+ "domain": {
44423
+ "type": "string"
44424
+ },
44425
+ "value": {
44426
+ "type": "string"
44427
+ },
44428
+ "reason": {
44429
+ "type": "string"
44430
+ }
44431
+ },
44432
+ "required": [
44433
+ "type",
44434
+ "domain",
44435
+ "value",
44436
+ "reason"
44437
+ ],
44438
+ "type": "object",
44439
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
44440
+ },
44441
+ "type": "array",
44442
+ "description": "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`."
44443
+ }
44444
+ },
44445
+ "required": [
44446
+ "name",
44447
+ "apexName",
44448
+ "projectId",
44449
+ "verified"
44450
+ ],
44451
+ "type": "object",
44452
+ "description": "List of domains associated with this environment"
44453
+ },
44454
+ "type": "array",
44455
+ "description": "List of domains associated with this environment"
44456
+ },
44457
+ "currentDeploymentAliases": {
44458
+ "items": {
44459
+ "type": "string"
44460
+ },
44461
+ "type": "array",
44462
+ "description": "List of aliases for the current deployment"
44463
+ },
44464
+ "createdAt": {
44465
+ "type": "number",
44466
+ "description": "Timestamp when the environment was created"
44467
+ },
44468
+ "updatedAt": {
44469
+ "type": "number",
44470
+ "description": "Timestamp when the environment was last updated"
44471
+ }
44472
+ },
44473
+ "required": [
44474
+ "id",
44475
+ "slug",
44476
+ "type",
44477
+ "createdAt",
44478
+ "updatedAt"
44479
+ ],
44480
+ "type": "object",
44481
+ "description": "Internal representation of a custom environment with all required properties"
42219
44482
  }
42220
44483
  }
42221
44484
  }
@@ -45203,10 +47466,10 @@
45203
47466
  "type": "string",
45204
47467
  "enum": [
45205
47468
  "system",
47469
+ "secret",
45206
47470
  "encrypted",
45207
47471
  "plain",
45208
- "sensitive",
45209
- "secret"
47472
+ "sensitive"
45210
47473
  ]
45211
47474
  },
45212
47475
  "sunsetSecretId": {
@@ -45605,10 +47868,10 @@
45605
47868
  "type": "string",
45606
47869
  "enum": [
45607
47870
  "system",
47871
+ "secret",
45608
47872
  "encrypted",
45609
47873
  "plain",
45610
- "sensitive",
45611
- "secret"
47874
+ "sensitive"
45612
47875
  ]
45613
47876
  },
45614
47877
  "sunsetSecretId": {
@@ -47688,10 +49951,10 @@
47688
49951
  "type": "string",
47689
49952
  "enum": [
47690
49953
  "system",
49954
+ "secret",
47691
49955
  "encrypted",
47692
49956
  "plain",
47693
- "sensitive",
47694
- "secret"
49957
+ "sensitive"
47695
49958
  ]
47696
49959
  },
47697
49960
  "sunsetSecretId": {
@@ -48103,10 +50366,10 @@
48103
50366
  "type": "string",
48104
50367
  "enum": [
48105
50368
  "system",
50369
+ "secret",
48106
50370
  "encrypted",
48107
50371
  "plain",
48108
- "sensitive",
48109
- "secret"
50372
+ "sensitive"
48110
50373
  ]
48111
50374
  },
48112
50375
  "sunsetSecretId": {
@@ -48513,10 +50776,10 @@
48513
50776
  "type": "string",
48514
50777
  "enum": [
48515
50778
  "system",
50779
+ "secret",
48516
50780
  "encrypted",
48517
50781
  "plain",
48518
- "sensitive",
48519
- "secret"
50782
+ "sensitive"
48520
50783
  ]
48521
50784
  },
48522
50785
  "sunsetSecretId": {
@@ -49031,10 +51294,10 @@
49031
51294
  "type": "string",
49032
51295
  "enum": [
49033
51296
  "system",
51297
+ "secret",
49034
51298
  "encrypted",
49035
51299
  "plain",
49036
- "sensitive",
49037
- "secret"
51300
+ "sensitive"
49038
51301
  ]
49039
51302
  },
49040
51303
  "sunsetSecretId": {
@@ -53571,15 +55834,6 @@
53571
55834
  "type": "number"
53572
55835
  }
53573
55836
  },
53574
- "required": [
53575
- "OwnerId",
53576
- "Id",
53577
- "Domain",
53578
- "Ip",
53579
- "CreatedAt",
53580
- "UpdatedAt",
53581
- "UpdatedAtHour"
53582
- ],
53583
55837
  "type": "object"
53584
55838
  },
53585
55839
  "type": "array"
@@ -53647,15 +55901,6 @@
53647
55901
  "type": "number"
53648
55902
  }
53649
55903
  },
53650
- "required": [
53651
- "OwnerId",
53652
- "Id",
53653
- "Domain",
53654
- "Ip",
53655
- "CreatedAt",
53656
- "UpdatedAt",
53657
- "UpdatedAtHour"
53658
- ],
53659
55904
  "type": "object"
53660
55905
  },
53661
55906
  "type": "array"
@@ -59610,6 +61855,195 @@
59610
61855
  ]
59611
61856
  }
59612
61857
  },
61858
+ "/aliases/{id}/protection-bypass": {
61859
+ "patch": {
61860
+ "description": "Update the protection bypass for the alias (used for user access \u0026 comment access for deployments). Used as shareable links and user scoped access for Vercel Authentication and also to allow external (logged in) people to comment on previews for Preview Comments (next-live-mode).",
61861
+ "security": [],
61862
+ "tags": [],
61863
+ "responses": {
61864
+ "200": {
61865
+ "description": "",
61866
+ "content": {
61867
+ "application/json": {
61868
+ "schema": {
61869
+ "additionalProperties": true,
61870
+ "type": "object"
61871
+ }
61872
+ }
61873
+ }
61874
+ },
61875
+ "400": {
61876
+ "description": "One of the provided values in the request body is invalid.\nOne of the provided values in the request query is invalid.",
61877
+ "content": {
61878
+ "application/json": {
61879
+ "schema": {
61880
+ "$ref": "#/components/schemas/VercelBadRequestError"
61881
+ }
61882
+ }
61883
+ }
61884
+ },
61885
+ "401": {
61886
+ "description": "",
61887
+ "content": {
61888
+ "application/json": {
61889
+ "schema": {
61890
+ "$ref": "#/components/schemas/VercelForbiddenError"
61891
+ }
61892
+ }
61893
+ }
61894
+ },
61895
+ "403": {
61896
+ "description": "You do not have permission to access this resource."
61897
+ },
61898
+ "404": {
61899
+ "description": "",
61900
+ "content": {
61901
+ "application/json": {
61902
+ "schema": {
61903
+ "$ref": "#/components/schemas/VercelNotFoundError"
61904
+ }
61905
+ }
61906
+ }
61907
+ },
61908
+ "409": {
61909
+ "description": ""
61910
+ },
61911
+ "428": {
61912
+ "description": ""
61913
+ },
61914
+ "500": {
61915
+ "description": ""
61916
+ }
61917
+ },
61918
+ "parameters": [
61919
+ {
61920
+ "name": "id",
61921
+ "description": "The alias or deployment ID",
61922
+ "in": "path",
61923
+ "required": true,
61924
+ "schema": {
61925
+ "type": "string",
61926
+ "description": "The alias or deployment ID"
61927
+ }
61928
+ }
61929
+ ],
61930
+ "requestBody": {
61931
+ "content": {
61932
+ "application/json": {
61933
+ "schema": {
61934
+ "oneOf": [
61935
+ {
61936
+ "type": "object",
61937
+ "properties": {
61938
+ "revoke": {
61939
+ "description": "Optional instructions for revoking and regenerating a shareable link",
61940
+ "type": "object",
61941
+ "properties": {
61942
+ "secret": {
61943
+ "description": "Sharebale link to revoked",
61944
+ "type": "string"
61945
+ },
61946
+ "regenerate": {
61947
+ "description": "Whether or not a new shareable link should be created after the provided secret is revoked",
61948
+ "type": "boolean"
61949
+ }
61950
+ },
61951
+ "required": [
61952
+ "secret",
61953
+ "regenerate"
61954
+ ]
61955
+ }
61956
+ },
61957
+ "additionalProperties": false
61958
+ },
61959
+ {
61960
+ "type": "object",
61961
+ "properties": {
61962
+ "scope": {
61963
+ "description": "Instructions for creating a user scoped protection bypass",
61964
+ "type": "object",
61965
+ "properties": {
61966
+ "userId": {
61967
+ "type": "string",
61968
+ "description": "Specified user id for the scoped bypass."
61969
+ },
61970
+ "email": {
61971
+ "type": "string",
61972
+ "format": "email",
61973
+ "description": "Specified email for the scoped bypass."
61974
+ },
61975
+ "access": {
61976
+ "enum": [
61977
+ "denied",
61978
+ "granted"
61979
+ ],
61980
+ "description": "Invitation status for the user scoped bypass."
61981
+ }
61982
+ },
61983
+ "allOf": [
61984
+ {
61985
+ "anyOf": [
61986
+ {
61987
+ "required": [
61988
+ "userId"
61989
+ ]
61990
+ },
61991
+ {
61992
+ "required": [
61993
+ "email"
61994
+ ]
61995
+ }
61996
+ ]
61997
+ },
61998
+ {
61999
+ "required": [
62000
+ "access"
62001
+ ]
62002
+ }
62003
+ ]
62004
+ }
62005
+ },
62006
+ "required": [
62007
+ "scope"
62008
+ ],
62009
+ "additionalProperties": false
62010
+ },
62011
+ {
62012
+ "type": "object",
62013
+ "properties": {
62014
+ "override": {
62015
+ "type": "object",
62016
+ "properties": {
62017
+ "scope": {
62018
+ "enum": [
62019
+ "alias-protection-override"
62020
+ ]
62021
+ },
62022
+ "action": {
62023
+ "enum": [
62024
+ "create",
62025
+ "revoke"
62026
+ ]
62027
+ }
62028
+ },
62029
+ "required": [
62030
+ "scope",
62031
+ "action"
62032
+ ]
62033
+ }
62034
+ },
62035
+ "required": [
62036
+ "override"
62037
+ ],
62038
+ "additionalProperties": false
62039
+ }
62040
+ ]
62041
+ }
62042
+ }
62043
+ }
62044
+ }
62045
+ }
62046
+ },
59613
62047
  "/v7/certs/{id}": {
59614
62048
  "get": {
59615
62049
  "description": "Get cert by id",
@@ -61262,9 +63696,6 @@
61262
63696
  "type": {
61263
63697
  "type": "string",
61264
63698
  "enum": [
61265
- "flag",
61266
- "flags-segment",
61267
- "flags-settings",
61268
63699
  "author",
61269
63700
  "bitbucket_login",
61270
63701
  "bold",
@@ -61276,6 +63707,9 @@
61276
63707
  "hook_name",
61277
63708
  "integration",
61278
63709
  "edge-config",
63710
+ "flag",
63711
+ "flags-segment",
63712
+ "flags-settings",
61279
63713
  "link",
61280
63714
  "project_name",
61281
63715
  "scaling_rules",
@@ -63061,12 +65495,6 @@
63061
65495
  "description": "The last editor full name or username."
63062
65496
  }
63063
65497
  },
63064
- "required": [
63065
- "created",
63066
- "key",
63067
- "id",
63068
- "decrypted"
63069
- ],
63070
65498
  "type": "object"
63071
65499
  },
63072
65500
  "newEnvVar": {
@@ -63184,12 +65612,6 @@
63184
65612
  "description": "The last editor full name or username."
63185
65613
  }
63186
65614
  },
63187
- "required": [
63188
- "created",
63189
- "key",
63190
- "id",
63191
- "decrypted"
63192
- ],
63193
65615
  "type": "object"
63194
65616
  },
63195
65617
  "updateDiff": {
@@ -63876,9 +66298,6 @@
63876
66298
  "enhanced"
63877
66299
  ]
63878
66300
  },
63879
- "abovePlan": {
63880
- "type": "boolean"
63881
- },
63882
66301
  "isDefaultBuildMachine": {
63883
66302
  "type": "boolean"
63884
66303
  },
@@ -64061,7 +66480,6 @@
64061
66480
  "blockedDueToOverageType": {
64062
66481
  "type": "string",
64063
66482
  "enum": [
64064
- "aiCredits",
64065
66483
  "analyticsUsage",
64066
66484
  "artifacts",
64067
66485
  "bandwidth",
@@ -64187,11 +66605,11 @@
64187
66605
  "enum": [
64188
66606
  "teams",
64189
66607
  "saml",
64190
- "link",
64191
66608
  "github",
64192
66609
  "gitlab",
64193
66610
  "bitbucket",
64194
66611
  "mail",
66612
+ "link",
64195
66613
  "import",
64196
66614
  "dsync",
64197
66615
  "feedback",
@@ -64288,25 +66706,6 @@
64288
66706
  },
64289
66707
  "overageUsageAlerts": {
64290
66708
  "properties": {
64291
- "aiCredits": {
64292
- "properties": {
64293
- "currentThreshold": {
64294
- "type": "number"
64295
- },
64296
- "warningAt": {
64297
- "nullable": true,
64298
- "type": "number"
64299
- },
64300
- "blockedAt": {
64301
- "nullable": true,
64302
- "type": "number"
64303
- }
64304
- },
64305
- "required": [
64306
- "currentThreshold"
64307
- ],
64308
- "type": "object"
64309
- },
64310
66709
  "analyticsUsage": {
64311
66710
  "properties": {
64312
66711
  "currentThreshold": {
@@ -65325,7 +67724,6 @@
65325
67724
  "overageReason": {
65326
67725
  "type": "string",
65327
67726
  "enum": [
65328
- "aiCredits",
65329
67727
  "analyticsUsage",
65330
67728
  "artifacts",
65331
67729
  "bandwidth",
@@ -65397,7 +67795,6 @@
65397
67795
  "overageReason": {
65398
67796
  "type": "string",
65399
67797
  "enum": [
65400
- "aiCredits",
65401
67798
  "analyticsUsage",
65402
67799
  "artifacts",
65403
67800
  "bandwidth",
@@ -65469,7 +67866,6 @@
65469
67866
  "overageReason": {
65470
67867
  "type": "string",
65471
67868
  "enum": [
65472
- "aiCredits",
65473
67869
  "analyticsUsage",
65474
67870
  "artifacts",
65475
67871
  "bandwidth",
@@ -66097,11 +68493,11 @@
66097
68493
  "enum": [
66098
68494
  "teams",
66099
68495
  "saml",
66100
- "link",
66101
68496
  "github",
66102
68497
  "gitlab",
66103
68498
  "bitbucket",
66104
68499
  "mail",
68500
+ "link",
66105
68501
  "import",
66106
68502
  "dsync",
66107
68503
  "feedback",
@@ -66621,6 +69017,45 @@
66621
69017
  "oldConnectConfigurations": {
66622
69018
  "nullable": true,
66623
69019
  "items": {
69020
+ "properties": {
69021
+ "envId": {
69022
+ "oneOf": [
69023
+ {
69024
+ "type": "string"
69025
+ },
69026
+ {
69027
+ "type": "string",
69028
+ "enum": [
69029
+ "preview",
69030
+ "production"
69031
+ ]
69032
+ }
69033
+ ]
69034
+ },
69035
+ "connectConfigurationId": {
69036
+ "type": "string"
69037
+ },
69038
+ "passive": {
69039
+ "type": "boolean"
69040
+ },
69041
+ "buildsEnabled": {
69042
+ "type": "boolean"
69043
+ },
69044
+ "createdAt": {
69045
+ "type": "number"
69046
+ },
69047
+ "updatedAt": {
69048
+ "type": "number"
69049
+ }
69050
+ },
69051
+ "required": [
69052
+ "envId",
69053
+ "connectConfigurationId",
69054
+ "passive",
69055
+ "buildsEnabled",
69056
+ "createdAt",
69057
+ "updatedAt"
69058
+ ],
66624
69059
  "type": "object"
66625
69060
  },
66626
69061
  "type": "array"
@@ -66628,6 +69063,45 @@
66628
69063
  "newConnectConfigurations": {
66629
69064
  "nullable": true,
66630
69065
  "items": {
69066
+ "properties": {
69067
+ "envId": {
69068
+ "oneOf": [
69069
+ {
69070
+ "type": "string"
69071
+ },
69072
+ {
69073
+ "type": "string",
69074
+ "enum": [
69075
+ "preview",
69076
+ "production"
69077
+ ]
69078
+ }
69079
+ ]
69080
+ },
69081
+ "connectConfigurationId": {
69082
+ "type": "string"
69083
+ },
69084
+ "passive": {
69085
+ "type": "boolean"
69086
+ },
69087
+ "buildsEnabled": {
69088
+ "type": "boolean"
69089
+ },
69090
+ "createdAt": {
69091
+ "type": "number"
69092
+ },
69093
+ "updatedAt": {
69094
+ "type": "number"
69095
+ }
69096
+ },
69097
+ "required": [
69098
+ "envId",
69099
+ "connectConfigurationId",
69100
+ "passive",
69101
+ "buildsEnabled",
69102
+ "createdAt",
69103
+ "updatedAt"
69104
+ ],
66631
69105
  "type": "object"
66632
69106
  },
66633
69107
  "type": "array"
@@ -67122,11 +69596,11 @@
67122
69596
  "type": {
67123
69597
  "type": "string",
67124
69598
  "enum": [
67125
- "integration",
67126
- "edge-config",
67127
69599
  "redis",
67128
69600
  "postgres",
67129
- "blob"
69601
+ "edge-config",
69602
+ "blob",
69603
+ "integration"
67130
69604
  ]
67131
69605
  }
67132
69606
  },
@@ -69213,7 +71687,6 @@
69213
71687
  "blockedDueToOverageType": {
69214
71688
  "type": "string",
69215
71689
  "enum": [
69216
- "aiCredits",
69217
71690
  "analyticsUsage",
69218
71691
  "artifacts",
69219
71692
  "bandwidth",
@@ -69387,10 +71860,6 @@
69387
71860
  ],
69388
71861
  "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
69389
71862
  },
69390
- "abovePlan": {
69391
- "type": "boolean",
69392
- "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
69393
- },
69394
71863
  "isDefaultBuildMachine": {
69395
71864
  "type": "boolean",
69396
71865
  "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."