platform-api 3.7.0 → 3.9.0

data/schema.json

@@ -644,8 +644,7 @@
       "type": [
         "object"
       ],
-      "definitions": {
-      },
+      "definitions": {},
       "links": [
         {
           "description": "Mark an add-on as provisioned for use.",
@@ -668,8 +667,7 @@
           "title": "Deprovision"
         }
       ],
-      "properties": {
-      }
+      "properties": {}
     },
     "add-on-attachment": {
       "description": "An add-on attachment represents a connection between an app and an add-on that it has been given access to.",
@@ -740,6 +738,21 @@
             "string"
           ]
         },
+        "namespace_config": {
+          "description": "attachment namespace config, used to specify namespace via key-value pairs",
+          "example": {
+            "cred": "analyst"
+          },
+          "type": [
+            "null",
+            "object"
+          ],
+          "additionalProperties": {
+            "type": [
+              "string"
+            ]
+          }
+        },
         "updated_at": {
           "description": "when add-on attachment was updated",
           "example": "2012-01-01T12:00:00Z",
@@ -791,6 +804,9 @@
               },
               "namespace": {
                 "$ref": "#/definitions/add-on-attachment/definitions/namespace"
+              },
+              "namespace_config": {
+                "$ref": "#/definitions/add-on-attachment/definitions/namespace_config"
               }
             },
             "required": [
@@ -1347,6 +1363,27 @@
           "type": [
             "string"
           ]
+        },
+        "supported_generations": {
+          "description": "generations supported by this add-on",
+          "readonly": true,
+          "type": [
+            "array"
+          ],
+          "items": {
+            "type": [
+              "object"
+            ],
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/generation/definitions/name",
+                "example": "cedar"
+              },
+              "id": {
+                "$ref": "#/definitions/generation/definitions/id"
+              }
+            }
+          }
         }
       },
       "links": [
@@ -1403,6 +1440,9 @@
         },
         "updated_at": {
           "$ref": "#/definitions/add-on-service/definitions/updated_at"
+        },
+        "supported_generations": {
+          "$ref": "#/definitions/add-on-service/definitions/supported_generations"
         }
       }
     },
@@ -1859,46 +1899,52 @@
         },
         "addon_service": {
           "description": "identity of add-on service",
-          "anyOf": [
-            {
-              "properties": {
-                "id": {
-                  "$ref": "#/definitions/add-on-service/definitions/id"
-                },
-                "name": {
-                  "$ref": "#/definitions/add-on-service/definitions/name"
-                }
+          "identity": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/add-on-service/definitions/id"
               },
-              "strictProperties": true,
-              "type": [
-                "object"
-              ]
+              {
+                "$ref": "#/definitions/add-on-service/definitions/name"
+              }
+            ]
+          },
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/add-on-service/definitions/id"
             },
-            {
-              "$ref": "#/definitions/add-on-service"
+            "name": {
+              "$ref": "#/definitions/add-on-service/definitions/name"
             }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
           ]
         },
         "plan": {
           "description": "identity of add-on plan",
-          "anyOf": [
-            {
-              "properties": {
-                "id": {
-                  "$ref": "#/definitions/plan/definitions/id"
-                },
-                "name": {
-                  "$ref": "#/definitions/plan/definitions/name"
-                }
+          "identity": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/plan/definitions/id"
               },
-              "strictProperties": true,
-              "type": [
-                "object"
-              ]
+              {
+                "$ref": "#/definitions/plan/definitions/name"
+              }
+            ]
+          },
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/plan/definitions/id"
             },
-            {
-              "$ref": "#/definitions/plan"
+            "name": {
+              "$ref": "#/definitions/plan/definitions/name"
             }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
           ]
         },
         "provision_message": {
@@ -3793,6 +3839,32 @@
             "string"
           ]
         },
+        "generation": {
+          "description": "Generation of the Heroku platform for this app",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "description": "unique identifier of the generation of the Heroku platform for this app",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "description": "unique name of the generation of the Heroku platform for this app",
+              "example": "cedar",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
         "git_url": {
           "description": "git repo URL of app",
           "example": "https://git.heroku.com/example.git",
@@ -4081,6 +4153,9 @@
         "created_at": {
           "$ref": "#/definitions/app/definitions/created_at"
         },
+        "generation": {
+          "$ref": "#/definitions/app/definitions/generation"
+        },
         "git_url": {
           "$ref": "#/definitions/app/definitions/git_url"
         },
@@ -4536,7 +4611,7 @@
     },
     "build": {
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "description": "A build represents the process of transforming a code tarball into a slug",
+      "description": "A build represents the process of transforming a code tarball into build artifacts",
       "title": "Heroku Build API - Build",
       "stability": "production",
       "strictProperties": false,
@@ -4553,7 +4628,7 @@
       ],
       "definitions": {
         "buildpacks": {
-          "description": "buildpacks executed for this build, in order",
+          "description": "buildpacks executed for this build, in order (only applicable to Cedar-generation apps)",
           "type": [
             "array",
             "null"
@@ -4592,6 +4667,14 @@
             "string"
           ]
         },
+        "generation": {
+          "description": "generation of build",
+          "example": "cedar",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "id": {
           "description": "unique identifier of build",
           "example": "01234567-89ab-cdef-0123-456789abcdef",
@@ -4810,6 +4893,9 @@
         "created_at": {
           "$ref": "#/definitions/build/definitions/created_at"
         },
+        "generation": {
+          "$ref": "#/definitions/build/definitions/generation"
+        },
         "id": {
           "$ref": "#/definitions/build/definitions/id"
         },
@@ -4823,7 +4909,7 @@
           "$ref": "#/definitions/build/definitions/release"
         },
         "slug": {
-          "description": "slug created by this build",
+          "description": "slug created by this build (only applicable for Cedar-generation apps)",
           "properties": {
             "id": {
               "$ref": "#/definitions/slug/definitions/id"
@@ -5688,6 +5774,14 @@
         "object"
       ],
       "definitions": {
+        "architecture": {
+          "description": "CPU architecture of this dyno size",
+          "example": "amd64",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "compute": {
           "description": "minimum vCPUs, non-dedicated may get more depending on load",
           "example": 1,
@@ -5704,8 +5798,34 @@
             "boolean"
           ]
         },
+        "generation": {
+          "description": "Generation of the Heroku platform for this dyno size",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "description": "unique identifier of the generation of the Heroku platform for this dyno size",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "description": "unique name of the generation of the Heroku platform for this dyno size",
+              "example": "cedar",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          }
+        },
         "id": {
-          "description": "unique identifier of this dyno size",
+          "description": "unique identifier of the dyno size",
           "example": "01234567-89ab-cdef-0123-456789abcdef",
           "format": "uuid",
           "readOnly": true,
@@ -5732,7 +5852,7 @@
           ]
         },
         "name": {
-          "description": "the name of this dyno-size",
+          "description": "name of the dyno size",
           "example": "eco",
           "readOnly": true,
           "type": [
@@ -5765,15 +5885,6 @@
             }
           }
         },
-        "dyno_units": {
-          "deprecated": true,
-          "description": "deprecated. See precise_dyno_units instead",
-          "example": 0,
-          "readOnly": true,
-          "type": [
-            "integer"
-          ]
-        },
         "precise_dyno_units": {
           "description": "unit of consumption for Heroku Enterprise customers to 2 decimal places",
           "example": 0.28,
@@ -5816,9 +5927,24 @@
             ]
           },
           "title": "List"
+        },
+        {
+          "description": "List available dyno sizes for an app",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/available-dyno-sizes",
+          "method": "GET",
+          "rel": "available-app-dynos",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/dyno-size"
+            }
+          },
+          "title": "List App Dyno Sizes"
         }
       ],
       "properties": {
+        "architecture": {
+          "$ref": "#/definitions/dyno-size/definitions/architecture"
+        },
         "compute": {
           "$ref": "#/definitions/dyno-size/definitions/compute"
         },
@@ -5828,12 +5954,12 @@
         "dedicated": {
           "$ref": "#/definitions/dyno-size/definitions/dedicated"
         },
-        "dyno_units": {
-          "$ref": "#/definitions/dyno-size/definitions/dyno_units"
-        },
         "precise_dyno_units": {
           "$ref": "#/definitions/dyno-size/definitions/precise_dyno_units"
         },
+        "generation": {
+          "$ref": "#/definitions/dyno-size/definitions/generation"
+        },
         "id": {
           "$ref": "#/definitions/dyno-size/definitions/id"
         },
@@ -5939,6 +6065,14 @@
             "string"
           ]
         },
+        "formation_type": {
+          "description": "the formation type of this process on this dyno",
+          "example": "run",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
         "force_no_tty": {
           "description": "force an attached one-off dyno to not run in a tty",
           "example": null,
@@ -6045,6 +6179,19 @@
           },
           "title": "Restart"
         },
+        {
+          "description": "Restart dynos of a given formation type.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formations/{(%23%2Fdefinitions%2Fdyno%2Fdefinitions%2Fformation_type)}",
+          "method": "DELETE",
+          "rel": "empty",
+          "targetSchema": {
+            "additionalProperties": false,
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Restart formation"
+        },
         {
           "description": "Restart all dynos.",
           "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos",
@@ -6071,6 +6218,19 @@
           },
           "title": "Stop"
         },
+        {
+          "description": "Stop dynos of a given formation type.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formations/{(%23%2Fdefinitions%2Fdyno%2Fdefinitions%2Fformation_type)}/actions/stop",
+          "method": "POST",
+          "rel": "empty",
+          "targetSchema": {
+            "additionalProperties": false,
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Stop formation"
+        },
         {
           "description": "Info for existing dyno.",
           "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos/{(%23%2Fdefinitions%2Fdyno%2Fdefinitions%2Fidentity)}",
@@ -6626,7 +6786,7 @@
           ]
         },
         "connect": {
-          "description": "average connect rows synced",
+          "description": "max connect rows synced",
           "example": 15000,
           "readOnly": true,
           "type": [
@@ -6913,6 +7073,14 @@
           "type": [
             "boolean"
           ]
+        },
+        "partner_benefits": {
+          "description": "whether the enterprise account is part of the Salesforce Partner Program",
+          "example": false,
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
         }
       },
       "links": [
@@ -6980,6 +7148,9 @@
         "trial": {
           "$ref": "#/definitions/enterprise-account/definitions/trial"
         },
+        "partner_benefits": {
+          "$ref": "#/definitions/enterprise-account/definitions/partner_benefits"
+        },
         "identity_provider": {
           "$ref": "#/definitions/enterprise-account/definitions/identity_provider"
         }
@@ -7076,6 +7247,45 @@
             "string"
           ]
         },
+        "dyno_size": {
+          "description": "dyno size",
+          "example": {
+            "id": "01234567-89ab-cdef-0123-456789abcdef"
+          },
+          "identity": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/dyno_size/definitions/id"
+              },
+              {
+                "$ref": "#/definitions/dyno_size/definitions/name"
+              }
+            ]
+          },
+          "properties": {
+            "id": {
+              "description": "unique identifier of the dyno size",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "description": "name of the dyno size",
+              "example": "Standard-1X",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "readOnly": false,
+          "type": [
+            "object"
+          ]
+        },
         "id": {
           "description": "unique identifier of this process type",
           "example": "01234567-89ab-cdef-0123-456789abcdef",
@@ -7104,7 +7314,8 @@
           ]
         },
         "size": {
-          "description": "dyno size",
+          "deprecated": true,
+          "description": "deprecated, refer to 'dyno_size' instead",
           "example": "standard-1X",
           "readOnly": false,
           "type": [
@@ -7133,12 +7344,12 @@
           "additionalProperties": false,
           "description": "Properties to update a process type",
           "properties": {
+            "dyno_size": {
+              "$ref": "#/definitions/formation/definitions/dyno_size"
+            },
             "quantity": {
               "$ref": "#/definitions/formation/definitions/quantity"
             },
-            "size": {
-              "$ref": "#/definitions/formation/definitions/size"
-            },
             "type": {
               "$ref": "#/definitions/formation/definitions/type"
             }
@@ -7192,7 +7403,7 @@
                 "items": {
                   "$ref": "#/definitions/formation/definitions/update"
                 },
-                "description": "Array with formation updates. Each element must have \"type\", the id or name of the process type to be updated, and can optionally update its \"quantity\" or \"size\"."
+                "description": "Array with formation updates. Each element must have \"type\", the id or name of the process type to be updated, and can optionally update its \"quantity\" or \"dyno_size\"."
               }
             },
             "required": [
@@ -7219,11 +7430,11 @@
           "rel": "update",
           "schema": {
             "properties": {
+              "dyno_size": {
+                "$ref": "#/definitions/formation/definitions/dyno_size"
+              },
               "quantity": {
                 "$ref": "#/definitions/formation/definitions/quantity"
-              },
-              "size": {
-                "$ref": "#/definitions/formation/definitions/size"
               }
             },
             "type": [
@@ -7260,6 +7471,20 @@
         "created_at": {
           "$ref": "#/definitions/formation/definitions/created_at"
         },
+        "dyno_size": {
+          "description": "dyno size",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/dyno-size/definitions/id"
+            },
+            "name": {
+              "$ref": "#/definitions/dyno-size/definitions/name"
+            }
+          },
+          "type": [
+            "object"
+          ]
+        },
         "id": {
           "$ref": "#/definitions/formation/definitions/id"
         },
@@ -7277,20 +7502,133 @@
         }
       }
     },
-    "identity-provider": {
-      "description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
+    "generation": {
+      "description": "A generation represents a version of the Heroku platform that includes the app execution environment, routing, telemetry, and build systems.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "stability": "production",
+      "stability": "prototype",
       "strictProperties": true,
-      "title": "Heroku Platform API - Identity Provider",
+      "title": "Heroku Platform API - Generation",
       "type": [
         "object"
       ],
       "definitions": {
-        "certificate": {
-          "description": "raw contents of the public certificate (eg: .crt or .pem file)",
-          "example": "-----BEGIN CERTIFICATE----- ...",
-          "readOnly": false,
+        "created_at": {
+          "description": "when generation was created",
+          "example": "2024-12-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "id": {
+          "description": "unique identifier of generation",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/generation/definitions/name"
+            },
+            {
+              "$ref": "#/definitions/generation/definitions/id"
+            }
+          ]
+        },
+        "name": {
+          "description": "unique name of generation",
+          "example": "fir",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "updated_at": {
+          "description": "when generation was updated",
+          "example": "2024-12-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Info for generation.",
+          "href": "/generations/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
+          "method": "GET",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/generation"
+          },
+          "title": "Info"
+        },
+        {
+          "description": "List available generations.",
+          "href": "/generations",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/generation"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List"
+        },
+        {
+          "description": "List available generations for a team.",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/available-generations",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/generation"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List by Team"
+        }
+      ],
+      "properties": {
+        "created_at": {
+          "$ref": "#/definitions/generation/definitions/created_at"
+        },
+        "id": {
+          "$ref": "#/definitions/generation/definitions/id"
+        },
+        "name": {
+          "$ref": "#/definitions/generation/definitions/name"
+        },
+        "updated_at": {
+          "$ref": "#/definitions/generation/definitions/updated_at"
+        }
+      }
+    },
+    "identity-provider": {
+      "description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "production",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Identity Provider",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "certificate": {
+          "description": "raw contents of the public certificate (eg: .crt or .pem file)",
+          "example": "-----BEGIN CERTIFICATE----- ...",
+          "readOnly": false,
           "type": [
             "string"
           ]
@@ -7641,6 +7979,9 @@
           "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/inbound-ruleset",
           "method": "PUT",
           "rel": "create",
+          "targetSchema": {
+            "$ref": "#/definitions/inbound-ruleset"
+          },
           "schema": {
             "type": [
               "object"
@@ -8426,9 +8767,17 @@
             "string"
           ]
         },
-        "dyno": {
-          "description": "dyno to limit results to",
-          "example": "web.1",
+        "dyno_name": {
+          "description": "dyno name to limit results to",
+          "example": "'web.1' (Cedar-generation) or 'web-1234abcde-123ab' (Fir-generation)",
+          "readOnly": false,
+          "type": [
+            "string"
+          ]
+        },
+        "type": {
+          "description": "process type to limit results to",
+          "example": "web",
           "readOnly": false,
           "type": [
             "string"
@@ -8500,8 +8849,11 @@
           "rel": "create",
           "schema": {
             "properties": {
-              "dyno": {
-                "$ref": "#/definitions/log-session/definitions/dyno"
+              "dyno_name": {
+                "$ref": "#/definitions/log-session/definitions/dyno_name"
+              },
+              "type": {
+                "$ref": "#/definitions/log-session/definitions/type"
               },
               "lines": {
                 "$ref": "#/definitions/log-session/definitions/lines"
@@ -8659,6 +9011,43 @@
           },
           "title": "Info"
         },
+        {
+          "description": "Update an existing OAuth authorization.",
+          "href": "/oauth/authorizations/{(%23%2Fdefinitions%2Foauth-authorization%2Fdefinitions%2Fidentity)}",
+          "method": "PATCH",
+          "rel": "update",
+          "targetSchema": {
+            "$ref": "#/definitions/oauth-authorization"
+          },
+          "schema": {
+            "properties": {
+              "description": {
+                "$ref": "#/definitions/oauth-authorization/definitions/description"
+              },
+              "client": {
+                "type": [
+                  "object"
+                ],
+                "description": "identifier of the client that obtained this authorization",
+                "properties": {
+                  "id": {
+                    "$ref": "#/definitions/oauth-client/definitions/id"
+                  },
+                  "secret": {
+                    "$ref": "#/definitions/oauth-client/definitions/secret"
+                  }
+                }
+              }
+            },
+            "required": [
+              "client"
+            ],
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Update"
+        },
         {
           "description": "List OAuth authorizations.",
           "href": "/oauth/authorizations",
@@ -8725,6 +9114,9 @@
         "created_at": {
           "$ref": "#/definitions/oauth-authorization/definitions/created_at"
         },
+        "description": {
+          "$ref": "#/definitions/oauth-authorization/definitions/description"
+        },
         "grant": {
           "description": "this authorization's grant",
           "properties": {
@@ -8769,6 +9161,19 @@
         "scope": {
           "$ref": "#/definitions/oauth-authorization/definitions/scope"
         },
+        "session": {
+          "description": "this authorization's session",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/oauth-token/definitions/id"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "null",
+            "object"
+          ]
+        },
         "updated_at": {
           "$ref": "#/definitions/oauth-authorization/definitions/updated_at"
         },
@@ -9039,10 +9444,8 @@
           ]
         }
       },
-      "links": [
-      ],
-      "properties": {
-      }
+      "links": [],
+      "properties": {}
     },
     "oauth-token": {
       "description": "OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)",
@@ -9285,185 +9688,368 @@
         }
       }
     },
-    "outbound-ruleset": {
-      "description": "An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ",
+    "oci-image": {
+      "description": "An OCI (Open Container Initiative) image is a standardized format for packaging and distributing containerized applications, ready to run on the platform.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "stability": "deprecation",
+      "stability": "prototype",
       "strictProperties": true,
-      "title": "Heroku Platform API - Outbound Ruleset",
-      "deprecated_at": "2024-04-30",
-      "deactivate_on": "2024-06-03",
+      "title": "Heroku Platform API - OCI Image",
       "type": [
         "object"
       ],
       "definitions": {
-        "target": {
-          "description": "is the target destination in CIDR notation",
-          "example": "1.1.1.1/1",
-          "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$",
+        "id": {
+          "description": "unique identifier of the OCI image",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "digest": {
+          "description": "unique identifier representing the content of the OCI image",
+          "example": "sha256:dc14ae5fbc1e7230e0a782bf216fb46500e210631703bcc6bab8acf2c6a23f42",
           "readOnly": false,
           "type": [
             "string"
           ]
         },
-        "created_at": {
-          "description": "when outbound-ruleset was created",
-          "example": "2012-01-01T12:00:00Z",
-          "format": "date-time",
-          "readOnly": true,
+        "architecture": {
+          "description": "build architecture for OCI image",
+          "example": "arm64",
+          "readOnly": false,
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/oci-image/definitions/id"
+            },
+            {
+              "$ref": "#/definitions/oci-image/definitions/digest"
+            }
+          ]
+        },
+        "base_image_name": {
+          "description": "name of the image used for the base layers of the OCI image",
+          "example": "heroku/heroku:22-cnb",
+          "readOnly": false,
           "type": [
             "string"
           ]
         },
-        "id": {
-          "description": "unique identifier of an outbound-ruleset",
-          "example": "01234567-89ab-cdef-0123-456789abcdef",
-          "format": "uuid",
-          "readOnly": true,
+        "base_top_layer": {
+          "description": "the digest of the top most layer of the base image.",
+          "example": "sha256:ea36ae5fbc1e7230e0a782bf216fb46500e210382703baa6bab8acf2c6a23f78",
+          "readOnly": false,
           "type": [
             "string"
           ]
         },
-        "port": {
-          "description": "an endpoint of communication in an operating system.",
-          "example": 80,
+        "commit": {
+          "description": "identification of the code in your version control system (eg: SHA of the git HEAD)",
+          "example": "60883d9e8947a57e04dc9124f25df004866a2051",
           "readOnly": false,
           "type": [
-            "integer"
+            "string"
           ]
         },
-        "protocol": {
-          "description": "formal standards and policies comprised of rules, procedures and formats that define communication between two or more devices over a network",
-          "example": "tcp",
+        "commit_description": {
+          "description": "an optional description of the provided commit",
+          "example": "fixed a bug with API documentation",
           "readOnly": false,
           "type": [
             "string"
           ]
         },
-        "identity": {
-          "anyOf": [
-            {
-              "$ref": "#/definitions/outbound-ruleset/definitions/id"
+        "image_repo": {
+          "description": "name of the image registry repository used for storage",
+          "example": "d7ba1ace-b396-4691-968c-37ae53153426/builds",
+          "readOnly": false,
+          "type": [
+            "string"
+          ]
+        },
+        "process_type": {
+          "description": "process type information such as names and commands",
+          "readOnly": false,
+          "properties": {
+            "name": {
+              "description": "name of the process type",
+              "example": "web",
+              "type": [
+                "string"
+              ]
+            },
+            "display_cmd": {
+              "description": "the detailed command used for display purposes",
+              "example": "bundle exec puma -p $PORT",
+              "type": [
+                "string"
+              ]
+            },
+            "command": {
+              "description": "the command that will be executed",
+              "example": "/cnb/process/web",
+              "type": [
+                "string"
+              ]
+            },
+            "working_dir": {
+              "description": "working directory",
+              "example": "/worspace/webapp",
+              "type": [
+                "string"
+              ]
+            },
+            "default": {
+              "description": "true if it is the default process type",
+              "example": true,
+              "type": [
+                "boolean",
+                "null"
+              ]
             }
+          },
+          "example": {
+            "name": "web",
+            "display_cmd": "bundle exec puma -p $PORT",
+            "command": "/cnb/process/web",
+            "working_dir": "/workspace/webapp",
+            "default": true
+          },
+          "type": [
+            "object"
           ]
         },
-        "rule": {
-          "description": "the combination of an IP address in CIDR notation, a from_port, to_port and protocol.",
+        "process_types": {
+          "description": "process types of the OCI image",
+          "patternProperties": {
+            "^[-\\w]{1,128}$": {
+              "$ref": "#/definitions/oci-image/definitions/process_type"
+            }
+          },
+          "example": {
+            "web": {
+              "name": "web",
+              "display_cmd": "bundle exec puma -p $PORT",
+              "command": "/cnb/process/web",
+              "working_dir": "/workspace/webapp",
+              "default": true
+            }
+          },
           "type": [
             "object"
-          ],
+          ]
+        },
+        "buildpack": {
+          "description": "set of executables that inspects app source code and creates a plan to build and run your image",
+          "readOnly": false,
           "properties": {
-            "target": {
-              "$ref": "#/definitions/outbound-ruleset/definitions/target"
+            "id": {
+              "description": "identifier of the buildpack",
+              "example": "heroku/ruby",
+              "type": [
+                "string"
+              ]
             },
-            "from_port": {
-              "$ref": "#/definitions/outbound-ruleset/definitions/port"
+            "version": {
+              "description": "version of the buildpack",
+              "example": "2.0.0",
+              "type": [
+                "string"
+              ]
             },
-            "to_port": {
-              "$ref": "#/definitions/outbound-ruleset/definitions/port"
+            "homepage": {
+              "description": "homepage of the buildpack",
+              "example": "https://github.com/heroku/buildpacks-ruby",
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "example": {
+            "id": "heroku/ruby",
+            "version": "2.0.0",
+            "homepage": "https://github.com/heroku/buildpacks-ruby"
+          },
+          "type": [
+            "object"
+          ]
+        },
+        "buildpacks": {
+          "description": "buildpacks of the OCI image",
+          "items": {
+            "$ref": "#/definitions/oci-image/definitions/buildpack"
+          },
+          "type": [
+            "array"
+          ]
+        },
+        "stack": {
+          "description": "stack associated to the OCI image",
+          "readOnly": false,
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/stack/definitions/id",
+              "example": "ba46bf09-7bd1-42fd-90df-a1a9a93eb4a2"
             },
-            "protocol": {
-              "$ref": "#/definitions/outbound-ruleset/definitions/protocol"
+            "name": {
+              "$ref": "#/definitions/stack/definitions/name",
+              "example": "cnb"
             }
           },
-          "required": [
-            "target",
-            "from_port",
-            "to_port",
-            "protocol"
+          "type": [
+            "object"
+          ]
+        },
+        "created_at": {
+          "description": "when the OCI image was created",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "updated_at": {
+          "description": "when the OCI image was updated",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "deleted_at": {
+          "description": "when OCI image was deleted",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
           ]
         }
       },
       "links": [
         {
-          "description": "Current outbound ruleset for a space",
-          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/outbound-ruleset",
-          "method": "GET",
-          "rel": "self",
-          "targetSchema": {
-            "$ref": "#/definitions/outbound-ruleset"
-          },
-          "title": "Current"
-        },
-        {
-          "description": "Info on an existing Outbound Ruleset",
-          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/outbound-rulesets/{(%23%2Fdefinitions%2Foutbound-ruleset%2Fdefinitions%2Fidentity)}",
+          "description": "Info for the OCI images of an app, filtered by identifier.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/oci-images/{(%23%2Fdefinitions%2Foci-image%2Fdefinitions%2Fidentity)}",
           "method": "GET",
           "rel": "self",
-          "targetSchema": {
-            "$ref": "#/definitions/outbound-ruleset"
-          },
-          "title": "Info"
-        },
-        {
-          "description": "List all Outbound Rulesets for a space",
-          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/outbound-rulesets",
-          "method": "GET",
-          "rel": "instances",
           "targetSchema": {
             "items": {
-              "$ref": "#/definitions/outbound-ruleset"
+              "$ref": "#/definitions/oci-image"
             },
             "type": [
               "array"
             ]
           },
-          "title": "List"
+          "title": "Info"
         },
         {
-          "description": "Create a new outbound ruleset",
-          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/outbound-ruleset",
-          "method": "PUT",
+          "description": "Create an new OCI image of an app",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/oci-images",
+          "method": "POST",
           "rel": "create",
           "schema": {
-            "type": [
-              "object"
-            ],
             "properties": {
-              "rules": {
-                "type": [
-                  "array"
-                ],
-                "items": {
-                  "$ref": "#/definitions/outbound-ruleset/definitions/rule"
-                }
+              "architecture": {
+                "$ref": "#/definitions/oci-image/definitions/architecture"
+              },
+              "base_image_name": {
+                "$ref": "#/definitions/oci-image/definitions/base_image_name"
+              },
+              "base_top_layer": {
+                "$ref": "#/definitions/oci-image/definitions/base_top_layer"
+              },
+              "commit": {
+                "$ref": "#/definitions/oci-image/definitions/commit"
+              },
+              "commit_description": {
+                "$ref": "#/definitions/oci-image/definitions/commit_description"
+              },
+              "image_repo": {
+                "$ref": "#/definitions/oci-image/definitions/image_repo"
+              },
+              "digest": {
+                "$ref": "#/definitions/oci-image/definitions/digest"
+              },
+              "stack": {
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/stack/definitions/name",
+                    "example": "cnb"
+                  },
+                  {
+                    "$ref": "#/definitions/stack/definitions/id"
+                  }
+                ]
+              },
+              "process_types": {
+                "$ref": "#/definitions/oci-image/definitions/process_types"
+              },
+              "buildpacks": {
+                "$ref": "#/definitions/oci-image/definitions/buildpacks"
               }
-            }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/oci-image"
           },
           "title": "Create"
         }
       ],
       "properties": {
         "id": {
-          "$ref": "#/definitions/outbound-ruleset/definitions/id"
+          "$ref": "#/definitions/oci-image/definitions/id"
         },
-        "space": {
-          "description": "identity of space",
-          "properties": {
-            "id": {
-              "$ref": "#/definitions/space/definitions/id"
-            },
-            "name": {
-              "$ref": "#/definitions/space/definitions/name"
-            }
-          },
-          "type": [
-            "object"
-          ]
+        "base_image_name": {
+          "$ref": "#/definitions/oci-image/definitions/base_image_name"
+        },
+        "base_top_layer": {
+          "$ref": "#/definitions/oci-image/definitions/base_top_layer"
+        },
+        "commit": {
+          "$ref": "#/definitions/oci-image/definitions/commit"
+        },
+        "commit_description": {
+          "$ref": "#/definitions/oci-image/definitions/commit_description"
+        },
+        "image_repo": {
+          "$ref": "#/definitions/oci-image/definitions/image_repo"
+        },
+        "digest": {
+          "$ref": "#/definitions/oci-image/definitions/digest"
+        },
+        "stack": {
+          "$ref": "#/definitions/oci-image/definitions/stack"
+        },
+        "process_types": {
+          "$ref": "#/definitions/oci-image/definitions/process_types"
+        },
+        "buildpacks": {
+          "$ref": "#/definitions/oci-image/definitions/buildpacks"
         },
         "created_at": {
-          "$ref": "#/definitions/outbound-ruleset/definitions/created_at"
+          "$ref": "#/definitions/oci-image/definitions/created_at"
         },
-        "rules": {
-          "type": [
-            "array"
-          ],
-          "items": {
-            "$ref": "#/definitions/outbound-ruleset/definitions/rule"
-          }
+        "updated_at": {
+          "$ref": "#/definitions/oci-image/definitions/updated_at"
         },
-        "created_by": {
-          "$ref": "#/definitions/account/definitions/email"
+        "architecture": {
+          "$ref": "#/definitions/oci-image/definitions/architecture"
+        },
+        "deleted_at": {
+          "$ref": "#/definitions/oci-image/definitions/deleted_at"
         }
       }
     },
@@ -9927,7 +10513,7 @@
       }
     },
     "pipeline-build": {
-      "description": "Information about latest builds of apps in a pipeline.",
+      "description": "Information about the latest builds of apps in a pipeline. A build represents the process of transforming code into build artifacts.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
       "strictProperties": true,
@@ -9935,7 +10521,131 @@
       "type": [
         "object"
       ],
-      "definitions": {
+      "definitions": {},
+      "properties": {
+        "app": {
+          "description": "app that the build belongs to",
+          "properties": {
+            "id": {
+              "description": "unique identifier of the app",
+              "$ref": "#/definitions/app/definitions/id"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
+          ]
+        },
+        "buildpacks": {
+          "$ref": "#/definitions/build/definitions/buildpacks"
+        },
+        "created_at": {
+          "description": "when the build was created",
+          "$ref": "#/definitions/build/definitions/created_at"
+        },
+        "id": {
+          "description": "unique identifier of the build",
+          "$ref": "#/definitions/build/definitions/id"
+        },
+        "output_stream_url": {
+          "description": "streaming URL of the build process output",
+          "$ref": "#/definitions/build/definitions/output_stream_url"
+        },
+        "source_blob": {
+          "description": "location of gzipped tarball of source code used to create build",
+          "properties": {
+            "checksum": {
+              "description": "an optional checksum of the gzipped tarball for verifying its integrity",
+              "example": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+              "readOnly": true,
+              "type": [
+                "null",
+                "string"
+              ]
+            },
+            "url": {
+              "description": "URL where gzipped tar archive of source code for build was downloaded.",
+              "example": "https://example.com/source.tgz?token=xyz",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "version": {
+              "description": "version of the gzipped tarball",
+              "example": "v1.3.0",
+              "readOnly": true,
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "version_description": {
+              "description": "version description of the gzipped tarball",
+              "example": "* Fake User: Change session key",
+              "readOnly": true,
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
+          ]
+        },
+        "release": {
+          "properties": {
+            "id": {
+              "description": "unique identifier of the release",
+              "$ref": "#/definitions/release/definitions/id"
+            }
+          },
+          "$ref": "#/definitions/build/definitions/release"
+        },
+        "slug": {
+          "description": "slug created by this build",
+          "properties": {
+            "id": {
+              "description": "unique identifier of the slug",
+              "$ref": "#/definitions/slug/definitions/id"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object",
+            "null"
+          ]
+        },
+        "stack": {
+          "description": "stack of the build",
+          "example": "heroku-24",
+          "$ref": "#/definitions/build/definitions/stack"
+        },
+        "status": {
+          "description": "status of the build",
+          "$ref": "#/definitions/build/definitions/status"
+        },
+        "updated_at": {
+          "description": "when the build was updated",
+          "$ref": "#/definitions/build/definitions/updated_at"
+        },
+        "user": {
+          "description": "user that started the build",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/account/definitions/id"
+            },
+            "email": {
+              "$ref": "#/definitions/account/definitions/email"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
+          ]
+        }
       },
       "links": [
         {
@@ -9945,7 +10655,7 @@
           "rel": "instances",
           "targetSchema": {
             "items": {
-              "$ref": "#/definitions/build"
+              "$ref": "#/definitions/pipeline-build"
             },
             "type": [
               "array"
@@ -9956,7 +10666,7 @@
       ]
     },
     "pipeline-config-var": {
-      "description": "Pipeline Config Vars allow you to manage the configuration information provided to a pipeline.",
+      "description": "Pipeline config vars in Heroku CI and review apps used to manage the configuration information for a pipeline.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
       "strictProperties": true,
@@ -9985,6 +10695,17 @@
           ]
         }
       },
+      "properties": {
+        "[\"NAME\"]: [\"value\"]": {
+          "type": [
+            "object"
+          ],
+          "description": "user-defined config var name and value",
+          "example": {
+            "FOO": "bar"
+          }
+        }
+      },
       "links": [
         {
           "description": "Get config-vars for a pipeline stage.",
@@ -10277,7 +10998,7 @@
       }
     },
     "pipeline-deployment": {
-      "description": "Information about latest deployments of apps in a pipeline.",
+      "description": "Information about the latest deployment of each app in a pipeline. A deployment is the process of moving the build artifacts to a target environment.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
       "strictProperties": true,
@@ -10285,11 +11006,105 @@
       "type": [
         "object"
       ],
-      "definitions": {
+      "$ref": "#/definitions/release",
+      "properties": {
+        "addon_plan_names": {
+          "description": "add-on plans installed on the app for this deployment",
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/plan/definitions/name"
+          }
+        },
+        "artifacts": {
+          "$ref": "#/definitions/release/definitions/artifact"
+        },
+        "app": {
+          "description": "app involved in the deployment",
+          "properties": {
+            "name": {
+              "description": "unique name of the app",
+              "$ref": "#/definitions/app/definitions/name"
+            },
+            "id": {
+              "description": "unique identifier of the app",
+              "$ref": "#/definitions/app/definitions/id"
+            }
+          },
+          "type": [
+            "object"
+          ]
+        },
+        "created_at": {
+          "description": "when the deployment was created",
+          "$ref": "#/definitions/release/definitions/created_at"
+        },
+        "description": {
+          "description": "description of changes in this deployment",
+          "$ref": "#/definitions/release/definitions/description"
+        },
+        "id": {
+          "description": "unique identifier of the deployment",
+          "$ref": "#/definitions/release/definitions/id"
+        },
+        "updated_at": {
+          "description": "when the deployment was updated",
+          "$ref": "#/definitions/release/definitions/updated_at"
+        },
+        "slug": {
+          "description": "slug running in this deployment",
+          "properties": {
+            "id": {
+              "description": "unique identifier of the slug",
+              "$ref": "#/definitions/slug/definitions/id"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object",
+            "null"
+          ]
+        },
+        "status": {
+          "description": "current status of the deployment",
+          "$ref": "#/definitions/release/definitions/status"
+        },
+        "user": {
+          "description": "user that created the deployment",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/account/definitions/id"
+            },
+            "email": {
+              "$ref": "#/definitions/account/definitions/email"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
+          ]
+        },
+        "version": {
+          "description": "unique version assigned to the deployment",
+          "$ref": "#/definitions/release/definitions/version"
+        },
+        "current": {
+          "description": "indicates if this deployment is the current one for the app",
+          "$ref": "#/definitions/release/definitions/current"
+        },
+        "output_stream_url": {
+          "description": "streaming URL for the release command output",
+          "$ref": "#/definitions/release/definitions/output_stream_url"
+        },
+        "eligible_for_rollback": {
+          "description": "indicates if this deployment is eligible for rollback",
+          "$ref": "#/definitions/release/definitions/eligible_for_rollback"
+        }
       },
       "links": [
         {
-          "description": "List latest slug releases for each app in a pipeline",
+          "description": "List latest deployments for each app in a pipeline. A deployment is a release that changed your source slug, container image, or Heroku processes.",
           "href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-deployments",
           "method": "GET",
           "rel": "instances",
@@ -10510,6 +11325,18 @@
                     "type": [
                       "object"
                     ]
+                  },
+                  "release": {
+                    "description": "the specific release to promote from (optional, defaults to current release)",
+                    "properties": {
+                      "id": {
+                        "$ref": "#/definitions/release/definitions/id"
+                      }
+                    },
+                    "strictProperties": true,
+                    "type": [
+                      "object"
+                    ]
                   }
                 },
                 "type": [
@@ -10626,7 +11453,7 @@
       }
     },
     "pipeline-release": {
-      "description": "Information about latest releases of apps in a pipeline.",
+      "description": "Information about the latest release of each app in a pipeline. A release makes a deployment available to end-users.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
       "strictProperties": true,
@@ -10634,7 +11461,96 @@
       "type": [
         "object"
       ],
-      "definitions": {
+      "properties": {
+        "addon_plan_names": {
+          "description": "add-on plans installed on the app for this release",
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/plan/definitions/name"
+          }
+        },
+        "artifacts": {
+          "$ref": "#/definitions/release/definitions/artifact"
+        },
+        "app": {
+          "description": "app involved in the release",
+          "properties": {
+            "name": {
+              "description": "unique name of the app",
+              "$ref": "#/definitions/app/definitions/name"
+            },
+            "id": {
+              "description": "unique identifier of the app",
+              "$ref": "#/definitions/app/definitions/id"
+            }
+          },
+          "type": [
+            "object"
+          ]
+        },
+        "created_at": {
+          "description": "when the release was created",
+          "$ref": "#/definitions/release/definitions/created_at"
+        },
+        "description": {
+          "$ref": "#/definitions/release/definitions/description"
+        },
+        "id": {
+          "description": "unique identifier of the release",
+          "$ref": "#/definitions/release/definitions/id"
+        },
+        "updated_at": {
+          "description": "when the release was updated",
+          "$ref": "#/definitions/release/definitions/updated_at"
+        },
+        "slug": {
+          "description": "slug running in the release",
+          "properties": {
+            "id": {
+              "description": "unique identifier of the slug",
+              "$ref": "#/definitions/slug/definitions/id"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object",
+            "null"
+          ]
+        },
+        "status": {
+          "$ref": "#/definitions/release/definitions/status"
+        },
+        "user": {
+          "description": "user that created the release",
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/account/definitions/id"
+            },
+            "email": {
+              "$ref": "#/definitions/account/definitions/email"
+            }
+          },
+          "strictProperties": true,
+          "type": [
+            "object"
+          ]
+        },
+        "version": {
+          "$ref": "#/definitions/release/definitions/version"
+        },
+        "current": {
+          "description": "indicates if this release is the current one for the app",
+          "$ref": "#/definitions/release/definitions/current"
+        },
+        "output_stream_url": {
+          "description": "streaming URL of the build process output",
+          "$ref": "#/definitions/release/definitions/output_stream_url"
+        },
+        "eligible_for_rollback": {
+          "$ref": "#/definitions/release/definitions/eligible_for_rollback"
+        }
       },
       "links": [
         {
@@ -10866,8 +11782,7 @@
               ]
             }
           },
-          "links": [
-          ],
+          "links": [],
           "properties": {
             "id": {
               "$ref": "#/definitions/pipeline/definitions/owner/definitions/id"
@@ -10893,6 +11808,49 @@
           "type": [
             "string"
           ]
+        },
+        "generation": {
+          "description": "the generation of the Heroku platform for this pipeline",
+          "definitions": {
+            "id": {
+              "description": "unique identifier of the generation of the Heroku platform for this pipeline",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "identity": {
+              "anyOf": [
+                {
+                  "$ref": "#/definitions/pipeline/definitions/generation/definitions/id"
+                },
+                {
+                  "$ref": "#/definitions/pipeline/definitions/generation/definitions/name"
+                }
+              ]
+            },
+            "name": {
+              "description": "unique name of the generation of the Heroku platform for this pipeline",
+              "example": "cedar",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/pipeline/definitions/generation/definitions/id"
+            },
+            "name": {
+              "$ref": "#/definitions/pipeline/definitions/generation/definitions/name"
+            }
+          },
+          "type": [
+            "object"
+          ]
         }
       },
       "links": [
@@ -10998,6 +11956,9 @@
         },
         "updated_at": {
           "$ref": "#/definitions/pipeline/definitions/updated_at"
+        },
+        "generation": {
+          "$ref": "#/definitions/pipeline/definitions/generation"
         }
       }
     },
@@ -11293,8 +12254,7 @@
         "object"
       ],
       "definitions": {
-        "identity": {
-        },
+        "identity": {},
         "remaining": {
           "description": "allowed requests remaining in current interval",
           "example": 2399,
@@ -11517,6 +12477,32 @@
         "object"
       ],
       "definitions": {
+        "artifact": {
+          "description": "a build artifact for the release",
+          "properties": {
+            "type": {
+              "description": "type of artifact",
+              "example": "slug",
+              "type": [
+                "string"
+              ]
+            },
+            "id": {
+              "anyOf": [
+                {
+                  "$ref": "#/definitions/slug/definitions/id"
+                },
+                {
+                  "$ref": "#/definitions/oci-image/definitions/id"
+                }
+              ]
+            }
+          },
+          "readOnly": true,
+          "type": [
+            "object"
+          ]
+        },
         "created_at": {
           "description": "when release was created",
           "example": "2012-01-01T12:00:00Z",
@@ -11539,7 +12525,8 @@
           "enum": [
             "failed",
             "pending",
-            "succeeded"
+            "succeeded",
+            "expired"
           ],
           "example": "succeeded",
           "readOnly": true,
@@ -11599,6 +12586,14 @@
             "string",
             "null"
           ]
+        },
+        "eligible_for_rollback": {
+          "description": "indicates if this release is eligible for rollback",
+          "example": true,
+          "readOnly": true,
+          "type": [
+            "boolean"
+          ]
         }
       },
       "links": [
@@ -11637,6 +12632,9 @@
               "description": {
                 "$ref": "#/definitions/release/definitions/description"
               },
+              "oci_image": {
+                "$ref": "#/definitions/oci-image/definitions/identity"
+              },
               "slug": {
                 "$ref": "#/definitions/slug/definitions/identity"
               }
@@ -11687,6 +12685,15 @@
             "$ref": "#/definitions/plan/definitions/name"
           }
         },
+        "artifacts": {
+          "description": "build artifacts for the release",
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/release/definitions/artifact"
+          }
+        },
         "app": {
           "description": "app involved in the release",
           "properties": {
@@ -11752,6 +12759,9 @@
         },
         "output_stream_url": {
           "$ref": "#/definitions/release/definitions/output_stream_url"
+        },
+        "eligible_for_rollback": {
+          "$ref": "#/definitions/release/definitions/eligible_for_rollback"
         }
       }
     },
@@ -12195,8 +13205,7 @@
               ]
             }
           },
-          "links": [
-          ],
+          "links": [],
           "properties": {
             "id": {
               "$ref": "#/definitions/review-app-config/definitions/deploy_target/definitions/id"
@@ -12484,6 +13493,16 @@
           "type": [
             "string"
           ]
+        },
+        "deleted_at": {
+          "description": "when slug was deleted",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
         }
       },
       "links": [
@@ -12614,6 +13633,9 @@
         },
         "updated_at": {
           "$ref": "#/definitions/slug/definitions/updated_at"
+        },
+        "deleted_at": {
+          "$ref": "#/definitions/slug/definitions/deleted_at"
         }
       }
     },
@@ -13554,6 +14576,32 @@
           "type": [
             "string"
           ]
+        },
+        "generation": {
+          "description": "Generation of the Heroku platform for this space",
+          "readOnly": true,
+          "type": [
+            "object"
+          ],
+          "properties": {
+            "id": {
+              "description": "unique identifier of the generation of the Heroku platform for this space",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "name": {
+              "description": "unique name of the generation of the Heroku platform for this space",
+              "example": "cedar",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          }
         }
       },
       "links": [
@@ -13639,6 +14687,14 @@
               },
               "log_drain_url": {
                 "$ref": "#/definitions/space/definitions/log_drain_url"
+              },
+              "generation": {
+                "description": "unique name of the generation of the Heroku platform for this space",
+                "example": "cedar",
+                "readOnly": true,
+                "type": [
+                  "string"
+                ]
               }
             },
             "required": [
@@ -13719,6 +14775,9 @@
         },
         "data_cidr": {
           "$ref": "#/definitions/space/definitions/data_cidr"
+        },
+        "generation": {
+          "$ref": "#/definitions/space/definitions/generation"
         }
       }
     },
@@ -13819,6 +14878,21 @@
             ]
           },
           "title": "List"
+        },
+        {
+          "description": "List available app stacks for an app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/available-stacks",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/stack"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List by App"
         }
       ],
       "properties": {
@@ -15583,7 +16657,7 @@
           }
         },
         "connect": {
-          "description": "average connect rows synced",
+          "description": "max connect rows synced",
           "example": 15000,
           "readOnly": true,
           "type": [
@@ -16313,6 +17387,309 @@
         }
       }
     },
+    "telemetry-drain": {
+      "description": "A telemetry drain forwards OpenTelemetry traces, metrics, and logs to your own consumer. For Fir-generation apps only.",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "prototype",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Telemetry Drain",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of telemetry drain",
+          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "format": "uuid",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/telemetry-drain/definitions/id"
+            }
+          ]
+        },
+        "created_at": {
+          "description": "when the telemetry drain was created",
+          "example": "2024-12-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "updated_at": {
+          "description": "when telemetry drain was last updated",
+          "example": "2012-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "signal": {
+          "description": "OpenTelemetry signal to be sent to the telemetry drain",
+          "readOnly": true,
+          "example": "traces",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "traces",
+            "metrics",
+            "logs"
+          ]
+        },
+        "signals": {
+          "description": "OpenTelemetry signals to send to telemetry drain",
+          "example": [
+            "traces",
+            "metrics"
+          ],
+          "readOnly": false,
+          "minItems": 1,
+          "uniqueItems": true,
+          "type": [
+            "array"
+          ],
+          "items": {
+            "$ref": "#/definitions/telemetry-drain/definitions/signal"
+          }
+        },
+        "exporter_type": {
+          "description": "the transport type to be used for your OpenTelemetry consumer",
+          "readOnly": true,
+          "example": "otlphttp",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "otlphttp",
+            "otlp"
+          ]
+        },
+        "exporter_endpoint": {
+          "description": "URI of your OpenTelemetry consumer",
+          "readOnly": false,
+          "example": "https://api.otelproduct.example/consumer",
+          "maxLength": 1000,
+          "type": [
+            "string"
+          ]
+        },
+        "exporter_headers": {
+          "description": "JSON headers to send to your OpenTelemetry consumer",
+          "readOnly": false,
+          "example": {
+            "API-Key": "example_api_key_012345",
+            "Environment": "production"
+          },
+          "default": {},
+          "additionalProperties": false,
+          "maxItems": 20,
+          "patternProperties": {
+            "^[A-Za-z0-9\\-_]{1,100}$": {
+              "maxLength": 1000,
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "type": [
+            "object"
+          ]
+        },
+        "exporter": {
+          "description": "OpenTelemetry exporter configuration",
+          "readOnly": false,
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "$ref": "#/definitions/telemetry-drain/definitions/exporter_type"
+            },
+            "endpoint": {
+              "$ref": "#/definitions/telemetry-drain/definitions/exporter_endpoint"
+            },
+            "headers": {
+              "$ref": "#/definitions/telemetry-drain/definitions/exporter_headers"
+            }
+          },
+          "required": [
+            "type",
+            "endpoint"
+          ],
+          "type": [
+            "object"
+          ]
+        },
+        "owner": {
+          "description": "entity that owns this telemetry drain",
+          "properties": {
+            "id": {
+              "description": "unique identifier of owner",
+              "example": "01234567-89ab-cdef-0123-456789abcdef",
+              "format": "uuid",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            },
+            "type": {
+              "description": "type of owner",
+              "enum": [
+                "app",
+                "space"
+              ],
+              "example": "app",
+              "readOnly": true,
+              "type": [
+                "string"
+              ]
+            }
+          },
+          "readOnly": false,
+          "required": [
+            "id",
+            "type"
+          ],
+          "type": [
+            "object"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Create a telemetry drain.",
+          "href": "/telemetry-drains",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "additionalProperties": false,
+            "properties": {
+              "owner": {
+                "$ref": "#/definitions/telemetry-drain/definitions/owner"
+              },
+              "signals": {
+                "$ref": "#/definitions/telemetry-drain/definitions/signals"
+              },
+              "exporter": {
+                "$ref": "#/definitions/telemetry-drain/definitions/exporter"
+              }
+            },
+            "required": [
+              "owner",
+              "signals",
+              "exporter"
+            ],
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/telemetry-drain"
+          },
+          "title": "Create"
+        },
+        {
+          "description": "List telemetry drains for an app.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/telemetry-drains",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/telemetry-drain"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List by App"
+        },
+        {
+          "description": "List telemetry drains for a space.",
+          "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/telemetry-drains",
+          "method": "GET",
+          "rel": "instances",
+          "targetSchema": {
+            "items": {
+              "$ref": "#/definitions/telemetry-drain"
+            },
+            "type": [
+              "array"
+            ]
+          },
+          "title": "List by Space"
+        },
+        {
+          "description": "Update a telemetry drain.",
+          "href": "/telemetry-drains/{(%23%2Fdefinitions%2Ftelemetry-drain%2Fdefinitions%2Fidentity)}",
+          "method": "PATCH",
+          "rel": "update",
+          "schema": {
+            "additionalProperties": false,
+            "properties": {
+              "signals": {
+                "$ref": "#/definitions/telemetry-drain/definitions/signals"
+              },
+              "exporter": {
+                "$ref": "#/definitions/telemetry-drain/definitions/exporter"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/telemetry-drain"
+          },
+          "title": "Update"
+        },
+        {
+          "description": "Delete a telemetry drain.",
+          "href": "/telemetry-drains/{(%23%2Fdefinitions%2Ftelemetry-drain%2Fdefinitions%2Fidentity)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "targetSchema": {
+            "$ref": "#/definitions/telemetry-drain"
+          },
+          "title": "Delete"
+        },
+        {
+          "description": "Info for a telemetry drain.",
+          "href": "/telemetry-drains/{(%23%2Fdefinitions%2Ftelemetry-drain%2Fdefinitions%2Fidentity)}",
+          "method": "GET",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/telemetry-drain"
+          },
+          "title": "Info"
+        }
+      ],
+      "properties": {
+        "created_at": {
+          "$ref": "#/definitions/telemetry-drain/definitions/created_at"
+        },
+        "id": {
+          "$ref": "#/definitions/telemetry-drain/definitions/id"
+        },
+        "owner": {
+          "$ref": "#/definitions/telemetry-drain/definitions/owner"
+        },
+        "signals": {
+          "$ref": "#/definitions/telemetry-drain/definitions/signals"
+        },
+        "exporter": {
+          "$ref": "#/definitions/telemetry-drain/definitions/exporter"
+        },
+        "updated_at": {
+          "$ref": "#/definitions/telemetry-drain/definitions/updated_at"
+        }
+      }
+    },
     "test-case": {
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "title": "Test Case",
@@ -17567,6 +18944,9 @@
     "formation": {
       "$ref": "#/definitions/formation"
     },
+    "generation": {
+      "$ref": "#/definitions/generation"
+    },
     "identity-provider": {
       "$ref": "#/definitions/identity-provider"
     },
@@ -17600,8 +18980,8 @@
     "oauth-token": {
       "$ref": "#/definitions/oauth-token"
     },
-    "outbound-ruleset": {
-      "$ref": "#/definitions/outbound-ruleset"
+    "oci-image": {
+      "$ref": "#/definitions/oci-image"
     },
     "password-reset": {
       "$ref": "#/definitions/password-reset"
@@ -17735,6 +19115,9 @@
     "team": {
       "$ref": "#/definitions/team"
     },
+    "telemetry-drain": {
+      "$ref": "#/definitions/telemetry-drain"
+    },
     "test-case": {
       "$ref": "#/definitions/test-case"
     },