platform-api 3.5.0 → 3.7.0
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.
- checksums.yaml +4 -4
- data/.circleci/config.yml +18 -0
- data/CHANGELOG.md +8 -0
- data/Rakefile +2 -1
- data/lib/platform-api/client.rb +452 -187
- data/lib/platform-api/version.rb +1 -1
- data/platform-api.gemspec +1 -1
- data/schema.json +343 -112
- metadata +7 -7
data/lib/platform-api/client.rb
CHANGED
@@ -83,7 +83,7 @@ module PlatformAPI
|
|
83
83
|
|
84
84
|
# Get the default options.
|
85
85
|
def self.default_options
|
86
|
-
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.
|
86
|
+
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.7.0"}
|
87
87
|
{
|
88
88
|
default_headers: default_headers,
|
89
89
|
url: "https://api.heroku.com"
|
@@ -98,6 +98,13 @@ module PlatformAPI
|
|
98
98
|
@client = client
|
99
99
|
end
|
100
100
|
|
101
|
+
# A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.
|
102
|
+
#
|
103
|
+
# @return [AccountDelinquency]
|
104
|
+
def account_delinquency
|
105
|
+
@account_delinquency_resource ||= AccountDelinquency.new(@client)
|
106
|
+
end
|
107
|
+
|
101
108
|
# An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
|
102
109
|
#
|
103
110
|
# @return [AccountFeature]
|
@@ -196,13 +203,6 @@ module PlatformAPI
|
|
196
203
|
@app_feature_resource ||= AppFeature.new(@client)
|
197
204
|
end
|
198
205
|
|
199
|
-
# App formation set describes the combination of process types with their quantities and sizes as well as application process tier
|
200
|
-
#
|
201
|
-
# @return [AppFormationSet]
|
202
|
-
def app_formation_set
|
203
|
-
@app_formation_set_resource ||= AppFormationSet.new(@client)
|
204
|
-
end
|
205
|
-
|
206
206
|
# An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
|
207
207
|
#
|
208
208
|
# @return [AppSetup]
|
@@ -357,7 +357,7 @@ module PlatformAPI
|
|
357
357
|
@formation_resource ||= Formation.new(@client)
|
358
358
|
end
|
359
359
|
|
360
|
-
# Identity Providers represent the SAML configuration of an Enterprise
|
360
|
+
# Identity Providers represent the SAML configuration of teams or an Enterprise account
|
361
361
|
#
|
362
362
|
# @return [IdentityProvider]
|
363
363
|
def identity_provider
|
@@ -686,6 +686,13 @@ module PlatformAPI
|
|
686
686
|
@team_daily_usage_resource ||= TeamDailyUsage.new(@client)
|
687
687
|
end
|
688
688
|
|
689
|
+
# A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.
|
690
|
+
#
|
691
|
+
# @return [TeamDelinquency]
|
692
|
+
def team_delinquency
|
693
|
+
@team_delinquency_resource ||= TeamDelinquency.new(@client)
|
694
|
+
end
|
695
|
+
|
689
696
|
# A team feature represents a feature enabled on a team account.
|
690
697
|
#
|
691
698
|
# @return [TeamFeature]
|
@@ -780,6 +787,18 @@ module PlatformAPI
|
|
780
787
|
|
781
788
|
private
|
782
789
|
|
790
|
+
# A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.
|
791
|
+
class AccountDelinquency
|
792
|
+
def initialize(client)
|
793
|
+
@client = client
|
794
|
+
end
|
795
|
+
|
796
|
+
# Account delinquency information.
|
797
|
+
def info()
|
798
|
+
@client.account_delinquency.info()
|
799
|
+
end
|
800
|
+
end
|
801
|
+
|
783
802
|
# An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
|
784
803
|
class AccountFeature
|
785
804
|
def initialize(client)
|
@@ -1242,13 +1261,6 @@ module PlatformAPI
|
|
1242
1261
|
end
|
1243
1262
|
end
|
1244
1263
|
|
1245
|
-
# App formation set describes the combination of process types with their quantities and sizes as well as application process tier
|
1246
|
-
class AppFormationSet
|
1247
|
-
def initialize(client)
|
1248
|
-
@client = client
|
1249
|
-
end
|
1250
|
-
end
|
1251
|
-
|
1252
1264
|
# An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
|
1253
1265
|
class AppSetup
|
1254
1266
|
def initialize(client)
|
@@ -1479,18 +1491,18 @@ module PlatformAPI
|
|
1479
1491
|
|
1480
1492
|
# Get archive for a single month.
|
1481
1493
|
#
|
1482
|
-
# @param
|
1494
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1483
1495
|
# @param archive_year: year of the archive
|
1484
1496
|
# @param archive_month: month of the archive
|
1485
|
-
def info(
|
1486
|
-
@client.archive.info(
|
1497
|
+
def info(enterprise_account_id_or_enterprise_account_name, archive_year, archive_month)
|
1498
|
+
@client.archive.info(enterprise_account_id_or_enterprise_account_name, archive_year, archive_month)
|
1487
1499
|
end
|
1488
1500
|
|
1489
1501
|
# List existing archives.
|
1490
1502
|
#
|
1491
|
-
# @param
|
1492
|
-
def list(
|
1493
|
-
@client.archive.list(
|
1503
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1504
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1505
|
+
@client.archive.list(enterprise_account_id_or_enterprise_account_name)
|
1494
1506
|
end
|
1495
1507
|
end
|
1496
1508
|
|
@@ -1502,9 +1514,9 @@ module PlatformAPI
|
|
1502
1514
|
|
1503
1515
|
# List existing events. Returns all events for one day, defaulting to current day. Order, actor, action, and type, and day query params can be specified as query parameters. For example, '/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&day=2020-09-30' would return events in descending order and only return app created events by the user with user@example.com email address.
|
1504
1516
|
#
|
1505
|
-
# @param
|
1506
|
-
def list(
|
1507
|
-
@client.audit_trail_event.list(
|
1517
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1518
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1519
|
+
@client.audit_trail_event.list(enterprise_account_id_or_enterprise_account_name)
|
1508
1520
|
end
|
1509
1521
|
end
|
1510
1522
|
|
@@ -1543,6 +1555,14 @@ module PlatformAPI
|
|
1543
1555
|
def delete_cache(app_id_or_app_name)
|
1544
1556
|
@client.build.delete_cache(app_id_or_app_name)
|
1545
1557
|
end
|
1558
|
+
|
1559
|
+
# Cancel running build.
|
1560
|
+
#
|
1561
|
+
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
1562
|
+
# @param build_id: unique identifier of build
|
1563
|
+
def cancel(app_id_or_app_name, build_id)
|
1564
|
+
@client.build.cancel(app_id_or_app_name, build_id)
|
1565
|
+
end
|
1546
1566
|
end
|
1547
1567
|
|
1548
1568
|
# A buildpack installation represents a buildpack that will be run against an app.
|
@@ -1804,34 +1824,34 @@ module PlatformAPI
|
|
1804
1824
|
|
1805
1825
|
# List members in an enterprise account.
|
1806
1826
|
#
|
1807
|
-
# @param
|
1808
|
-
def list(
|
1809
|
-
@client.enterprise_account_member.list(
|
1827
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1828
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1829
|
+
@client.enterprise_account_member.list(enterprise_account_id_or_enterprise_account_name)
|
1810
1830
|
end
|
1811
1831
|
|
1812
1832
|
# Create a member in an enterprise account.
|
1813
1833
|
#
|
1814
|
-
# @param
|
1834
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1815
1835
|
# @param body: the object to pass as the request payload
|
1816
|
-
def create(
|
1817
|
-
@client.enterprise_account_member.create(
|
1836
|
+
def create(enterprise_account_id_or_enterprise_account_name, body = {})
|
1837
|
+
@client.enterprise_account_member.create(enterprise_account_id_or_enterprise_account_name, body)
|
1818
1838
|
end
|
1819
1839
|
|
1820
1840
|
# Update a member in an enterprise account.
|
1821
1841
|
#
|
1822
|
-
# @param
|
1842
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1823
1843
|
# @param account_email_or_account_id: unique email address of account or unique identifier of an account
|
1824
1844
|
# @param body: the object to pass as the request payload
|
1825
|
-
def update(
|
1826
|
-
@client.enterprise_account_member.update(
|
1845
|
+
def update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body = {})
|
1846
|
+
@client.enterprise_account_member.update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body)
|
1827
1847
|
end
|
1828
1848
|
|
1829
1849
|
# delete a member in an enterprise account.
|
1830
1850
|
#
|
1831
|
-
# @param
|
1851
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1832
1852
|
# @param account_email_or_account_id: unique email address of account or unique identifier of an account
|
1833
|
-
def delete(
|
1834
|
-
@client.enterprise_account_member.delete(
|
1853
|
+
def delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
|
1854
|
+
@client.enterprise_account_member.delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
|
1835
1855
|
end
|
1836
1856
|
end
|
1837
1857
|
|
@@ -1864,17 +1884,17 @@ module PlatformAPI
|
|
1864
1884
|
|
1865
1885
|
# Information about an enterprise account.
|
1866
1886
|
#
|
1867
|
-
# @param
|
1868
|
-
def info(
|
1869
|
-
@client.enterprise_account.info(
|
1887
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1888
|
+
def info(enterprise_account_id_or_enterprise_account_name)
|
1889
|
+
@client.enterprise_account.info(enterprise_account_id_or_enterprise_account_name)
|
1870
1890
|
end
|
1871
1891
|
|
1872
1892
|
# Update enterprise account properties
|
1873
1893
|
#
|
1874
|
-
# @param
|
1894
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1875
1895
|
# @param body: the object to pass as the request payload
|
1876
|
-
def update(
|
1877
|
-
@client.enterprise_account.update(
|
1896
|
+
def update(enterprise_account_id_or_enterprise_account_name, body = {})
|
1897
|
+
@client.enterprise_account.update(enterprise_account_id_or_enterprise_account_name, body)
|
1878
1898
|
end
|
1879
1899
|
end
|
1880
1900
|
|
@@ -1931,7 +1951,7 @@ module PlatformAPI
|
|
1931
1951
|
end
|
1932
1952
|
end
|
1933
1953
|
|
1934
|
-
# Identity Providers represent the SAML configuration of an Enterprise
|
1954
|
+
# Identity Providers represent the SAML configuration of teams or an Enterprise account
|
1935
1955
|
class IdentityProvider
|
1936
1956
|
def initialize(client)
|
1937
1957
|
@client = client
|
@@ -2193,7 +2213,7 @@ module PlatformAPI
|
|
2193
2213
|
@client.oauth_client.delete(oauth_client_id)
|
2194
2214
|
end
|
2195
2215
|
|
2196
|
-
# Info for an OAuth client
|
2216
|
+
# Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.
|
2197
2217
|
#
|
2198
2218
|
# @param oauth_client_id: unique identifier of this OAuth client
|
2199
2219
|
def info(oauth_client_id)
|
@@ -3069,34 +3089,34 @@ module PlatformAPI
|
|
3069
3089
|
|
3070
3090
|
# Delete an existing collaborator from a team app.
|
3071
3091
|
#
|
3072
|
-
# @param
|
3092
|
+
# @param team_app_identity:
|
3073
3093
|
# @param collaborator_email: invited email address of collaborator
|
3074
|
-
def delete(
|
3075
|
-
@client.team_app_collaborator.delete(
|
3094
|
+
def delete(team_app_identity, collaborator_email)
|
3095
|
+
@client.team_app_collaborator.delete(team_app_identity, collaborator_email)
|
3076
3096
|
end
|
3077
3097
|
|
3078
3098
|
# Info for a collaborator on a team app.
|
3079
3099
|
#
|
3080
|
-
# @param
|
3100
|
+
# @param team_app_identity:
|
3081
3101
|
# @param collaborator_email: invited email address of collaborator
|
3082
|
-
def info(
|
3083
|
-
@client.team_app_collaborator.info(
|
3102
|
+
def info(team_app_identity, collaborator_email)
|
3103
|
+
@client.team_app_collaborator.info(team_app_identity, collaborator_email)
|
3084
3104
|
end
|
3085
3105
|
|
3086
3106
|
# Update an existing collaborator from a team app.
|
3087
3107
|
#
|
3088
|
-
# @param
|
3108
|
+
# @param team_app_identity:
|
3089
3109
|
# @param collaborator_email: invited email address of collaborator
|
3090
3110
|
# @param body: the object to pass as the request payload
|
3091
|
-
def update(
|
3092
|
-
@client.team_app_collaborator.update(
|
3111
|
+
def update(team_app_identity, collaborator_email, body = {})
|
3112
|
+
@client.team_app_collaborator.update(team_app_identity, collaborator_email, body)
|
3093
3113
|
end
|
3094
3114
|
|
3095
3115
|
# List collaborators on a team app.
|
3096
3116
|
#
|
3097
|
-
# @param
|
3098
|
-
def list(
|
3099
|
-
@client.team_app_collaborator.list(
|
3117
|
+
# @param team_app_identity:
|
3118
|
+
def list(team_app_identity)
|
3119
|
+
@client.team_app_collaborator.list(team_app_identity)
|
3100
3120
|
end
|
3101
3121
|
end
|
3102
3122
|
|
@@ -3127,33 +3147,33 @@ module PlatformAPI
|
|
3127
3147
|
|
3128
3148
|
# Info for a team app.
|
3129
3149
|
#
|
3130
|
-
# @param
|
3131
|
-
def info(
|
3132
|
-
@client.team_app.info(
|
3150
|
+
# @param team_app_identity:
|
3151
|
+
def info(team_app_identity)
|
3152
|
+
@client.team_app.info(team_app_identity)
|
3133
3153
|
end
|
3134
3154
|
|
3135
3155
|
# Lock or unlock a team app.
|
3136
3156
|
#
|
3137
|
-
# @param
|
3157
|
+
# @param team_app_identity:
|
3138
3158
|
# @param body: the object to pass as the request payload
|
3139
|
-
def update_locked(
|
3140
|
-
@client.team_app.update_locked(
|
3159
|
+
def update_locked(team_app_identity, body = {})
|
3160
|
+
@client.team_app.update_locked(team_app_identity, body)
|
3141
3161
|
end
|
3142
3162
|
|
3143
3163
|
# Transfer an existing team app to another Heroku account.
|
3144
3164
|
#
|
3145
|
-
# @param
|
3165
|
+
# @param team_app_identity:
|
3146
3166
|
# @param body: the object to pass as the request payload
|
3147
|
-
def transfer_to_account(
|
3148
|
-
@client.team_app.transfer_to_account(
|
3167
|
+
def transfer_to_account(team_app_identity, body = {})
|
3168
|
+
@client.team_app.transfer_to_account(team_app_identity, body)
|
3149
3169
|
end
|
3150
3170
|
|
3151
3171
|
# Transfer an existing team app to another team.
|
3152
3172
|
#
|
3153
|
-
# @param
|
3173
|
+
# @param team_app_identity:
|
3154
3174
|
# @param body: the object to pass as the request payload
|
3155
|
-
def transfer_to_team(
|
3156
|
-
@client.team_app.transfer_to_team(
|
3175
|
+
def transfer_to_team(team_app_identity, body = {})
|
3176
|
+
@client.team_app.transfer_to_team(team_app_identity, body)
|
3157
3177
|
end
|
3158
3178
|
|
3159
3179
|
# List team apps.
|
@@ -3180,6 +3200,20 @@ module PlatformAPI
|
|
3180
3200
|
end
|
3181
3201
|
end
|
3182
3202
|
|
3203
|
+
# A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.
|
3204
|
+
class TeamDelinquency
|
3205
|
+
def initialize(client)
|
3206
|
+
@client = client
|
3207
|
+
end
|
3208
|
+
|
3209
|
+
# Team delinquency information.
|
3210
|
+
#
|
3211
|
+
# @param team_name_or_team_id: unique name of team or unique identifier of team
|
3212
|
+
def info(team_name_or_team_id)
|
3213
|
+
@client.team_delinquency.info(team_name_or_team_id)
|
3214
|
+
end
|
3215
|
+
end
|
3216
|
+
|
3183
3217
|
# A team feature represents a feature enabled on a team account.
|
3184
3218
|
class TeamFeature
|
3185
3219
|
def initialize(client)
|
@@ -3416,17 +3450,17 @@ module PlatformAPI
|
|
3416
3450
|
|
3417
3451
|
# List teams for an enterprise account.
|
3418
3452
|
#
|
3419
|
-
# @param
|
3420
|
-
def list_by_enterprise_account(
|
3421
|
-
@client.team.list_by_enterprise_account(
|
3453
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
3454
|
+
def list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
|
3455
|
+
@client.team.list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
|
3422
3456
|
end
|
3423
3457
|
|
3424
3458
|
# Create a team in an enterprise account.
|
3425
3459
|
#
|
3426
|
-
# @param
|
3460
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
3427
3461
|
# @param body: the object to pass as the request payload
|
3428
|
-
def create_in_enterprise_account(
|
3429
|
-
@client.team.create_in_enterprise_account(
|
3462
|
+
def create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body = {})
|
3463
|
+
@client.team.create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body)
|
3430
3464
|
end
|
3431
3465
|
end
|
3432
3466
|
|
@@ -3578,6 +3612,58 @@ module PlatformAPI
|
|
3578
3612
|
"object"
|
3579
3613
|
],
|
3580
3614
|
"definitions": {
|
3615
|
+
"account-delinquency": {
|
3616
|
+
"description": "A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.",
|
3617
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
3618
|
+
"stability": "development",
|
3619
|
+
"strictProperties": true,
|
3620
|
+
"title": "Heroku Platform API - Account Delinquency",
|
3621
|
+
"type": [
|
3622
|
+
"object"
|
3623
|
+
],
|
3624
|
+
"definitions": {
|
3625
|
+
"scheduled_suspension_time": {
|
3626
|
+
"description": "scheduled time of when we will suspend your account due to delinquency",
|
3627
|
+
"example": "2024-01-01T12:00:00Z",
|
3628
|
+
"format": "date-time",
|
3629
|
+
"readOnly": true,
|
3630
|
+
"type": [
|
3631
|
+
"string",
|
3632
|
+
"null"
|
3633
|
+
]
|
3634
|
+
},
|
3635
|
+
"scheduled_deletion_time": {
|
3636
|
+
"description": "scheduled time of when we will delete your account due to delinquency",
|
3637
|
+
"example": "2024-01-01T12:00:00Z",
|
3638
|
+
"format": "date-time",
|
3639
|
+
"readOnly": true,
|
3640
|
+
"type": [
|
3641
|
+
"string",
|
3642
|
+
"null"
|
3643
|
+
]
|
3644
|
+
}
|
3645
|
+
},
|
3646
|
+
"links": [
|
3647
|
+
{
|
3648
|
+
"description": "Account delinquency information.",
|
3649
|
+
"href": "/account/delinquency",
|
3650
|
+
"method": "GET",
|
3651
|
+
"rel": "self",
|
3652
|
+
"targetSchema": {
|
3653
|
+
"$ref": "#/definitions/account-delinquency"
|
3654
|
+
},
|
3655
|
+
"title": "Info"
|
3656
|
+
}
|
3657
|
+
],
|
3658
|
+
"properties": {
|
3659
|
+
"scheduled_suspension_time": {
|
3660
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_suspension_time"
|
3661
|
+
},
|
3662
|
+
"scheduled_deletion_time": {
|
3663
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_deletion_time"
|
3664
|
+
}
|
3665
|
+
}
|
3666
|
+
},
|
3581
3667
|
"account-feature": {
|
3582
3668
|
"description": "An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.",
|
3583
3669
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -4173,7 +4259,7 @@ module PlatformAPI
|
|
4173
4259
|
"description": "Mark an add-on as provisioned for use.",
|
4174
4260
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/provision",
|
4175
4261
|
"method": "POST",
|
4176
|
-
"rel": "
|
4262
|
+
"rel": "update",
|
4177
4263
|
"targetSchema": {
|
4178
4264
|
"$ref": "#/definitions/add-on"
|
4179
4265
|
},
|
@@ -4183,7 +4269,7 @@ module PlatformAPI
|
|
4183
4269
|
"description": "Mark an add-on as deprovisioned.",
|
4184
4270
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/deprovision",
|
4185
4271
|
"method": "POST",
|
4186
|
-
"rel": "
|
4272
|
+
"rel": "update",
|
4187
4273
|
"targetSchema": {
|
4188
4274
|
"$ref": "#/definitions/add-on"
|
4189
4275
|
},
|
@@ -5196,8 +5282,24 @@ module PlatformAPI
|
|
5196
5282
|
"description": "Add-ons represent add-ons that have been provisioned and attached to one or more apps.",
|
5197
5283
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
5198
5284
|
"stability": "production",
|
5199
|
-
"strictProperties": true,
|
5200
5285
|
"title": "Heroku Platform API - Add-on",
|
5286
|
+
"additionalProperties": false,
|
5287
|
+
"required": [
|
5288
|
+
"actions",
|
5289
|
+
"addon_service",
|
5290
|
+
"billing_entity",
|
5291
|
+
"app",
|
5292
|
+
"billed_price",
|
5293
|
+
"config_vars",
|
5294
|
+
"created_at",
|
5295
|
+
"id",
|
5296
|
+
"name",
|
5297
|
+
"plan",
|
5298
|
+
"provider_id",
|
5299
|
+
"state",
|
5300
|
+
"updated_at",
|
5301
|
+
"web_url"
|
5302
|
+
],
|
5201
5303
|
"type": [
|
5202
5304
|
"object"
|
5203
5305
|
],
|
@@ -5362,6 +5464,57 @@ module PlatformAPI
|
|
5362
5464
|
"null",
|
5363
5465
|
"string"
|
5364
5466
|
]
|
5467
|
+
},
|
5468
|
+
"addon_service": {
|
5469
|
+
"description": "identity of add-on service",
|
5470
|
+
"anyOf": [
|
5471
|
+
{
|
5472
|
+
"properties": {
|
5473
|
+
"id": {
|
5474
|
+
"$ref": "#/definitions/add-on-service/definitions/id"
|
5475
|
+
},
|
5476
|
+
"name": {
|
5477
|
+
"$ref": "#/definitions/add-on-service/definitions/name"
|
5478
|
+
}
|
5479
|
+
},
|
5480
|
+
"strictProperties": true,
|
5481
|
+
"type": [
|
5482
|
+
"object"
|
5483
|
+
]
|
5484
|
+
},
|
5485
|
+
{
|
5486
|
+
"$ref": "#/definitions/add-on-service"
|
5487
|
+
}
|
5488
|
+
]
|
5489
|
+
},
|
5490
|
+
"plan": {
|
5491
|
+
"description": "identity of add-on plan",
|
5492
|
+
"anyOf": [
|
5493
|
+
{
|
5494
|
+
"properties": {
|
5495
|
+
"id": {
|
5496
|
+
"$ref": "#/definitions/plan/definitions/id"
|
5497
|
+
},
|
5498
|
+
"name": {
|
5499
|
+
"$ref": "#/definitions/plan/definitions/name"
|
5500
|
+
}
|
5501
|
+
},
|
5502
|
+
"strictProperties": true,
|
5503
|
+
"type": [
|
5504
|
+
"object"
|
5505
|
+
]
|
5506
|
+
},
|
5507
|
+
{
|
5508
|
+
"$ref": "#/definitions/plan"
|
5509
|
+
}
|
5510
|
+
]
|
5511
|
+
},
|
5512
|
+
"provision_message": {
|
5513
|
+
"description": "A provision message",
|
5514
|
+
"readOnly": true,
|
5515
|
+
"type": [
|
5516
|
+
"string"
|
5517
|
+
]
|
5365
5518
|
}
|
5366
5519
|
},
|
5367
5520
|
"links": [
|
@@ -5492,6 +5645,9 @@ module PlatformAPI
|
|
5492
5645
|
"object"
|
5493
5646
|
]
|
5494
5647
|
},
|
5648
|
+
"targetSchema": {
|
5649
|
+
"$ref": "#/definitions/add-on"
|
5650
|
+
},
|
5495
5651
|
"title": "Update"
|
5496
5652
|
},
|
5497
5653
|
{
|
@@ -5564,19 +5720,7 @@ module PlatformAPI
|
|
5564
5720
|
"$ref": "#/definitions/add-on/definitions/actions"
|
5565
5721
|
},
|
5566
5722
|
"addon_service": {
|
5567
|
-
"
|
5568
|
-
"properties": {
|
5569
|
-
"id": {
|
5570
|
-
"$ref": "#/definitions/add-on-service/definitions/id"
|
5571
|
-
},
|
5572
|
-
"name": {
|
5573
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
5574
|
-
}
|
5575
|
-
},
|
5576
|
-
"strictProperties": true,
|
5577
|
-
"type": [
|
5578
|
-
"object"
|
5579
|
-
]
|
5723
|
+
"$ref": "#/definitions/add-on/definitions/addon_service"
|
5580
5724
|
},
|
5581
5725
|
"billing_entity": {
|
5582
5726
|
"description": "billing entity associated with this add-on",
|
@@ -5663,23 +5807,14 @@ module PlatformAPI
|
|
5663
5807
|
"$ref": "#/definitions/add-on/definitions/name"
|
5664
5808
|
},
|
5665
5809
|
"plan": {
|
5666
|
-
"
|
5667
|
-
"properties": {
|
5668
|
-
"id": {
|
5669
|
-
"$ref": "#/definitions/plan/definitions/id"
|
5670
|
-
},
|
5671
|
-
"name": {
|
5672
|
-
"$ref": "#/definitions/plan/definitions/name"
|
5673
|
-
}
|
5674
|
-
},
|
5675
|
-
"strictProperties": true,
|
5676
|
-
"type": [
|
5677
|
-
"object"
|
5678
|
-
]
|
5810
|
+
"$ref": "#/definitions/add-on/definitions/plan"
|
5679
5811
|
},
|
5680
5812
|
"provider_id": {
|
5681
5813
|
"$ref": "#/definitions/add-on/definitions/provider_id"
|
5682
5814
|
},
|
5815
|
+
"provision_message": {
|
5816
|
+
"$ref": "#/definitions/add-on/definitions/provision_message"
|
5817
|
+
},
|
5683
5818
|
"state": {
|
5684
5819
|
"$ref": "#/definitions/add-on/definitions/state"
|
5685
5820
|
},
|
@@ -6029,63 +6164,6 @@ module PlatformAPI
|
|
6029
6164
|
}
|
6030
6165
|
}
|
6031
6166
|
},
|
6032
|
-
"app-formation-set": {
|
6033
|
-
"description": "App formation set describes the combination of process types with their quantities and sizes as well as application process tier",
|
6034
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
6035
|
-
"stability": "development",
|
6036
|
-
"strictProperties": true,
|
6037
|
-
"title": "Heroku Platform API - Application Formation Set",
|
6038
|
-
"type": [
|
6039
|
-
"object"
|
6040
|
-
],
|
6041
|
-
"properties": {
|
6042
|
-
"description": {
|
6043
|
-
"description": "a string representation of the formation set",
|
6044
|
-
"example": "web@2:Standard-2X worker@3:Performance-M",
|
6045
|
-
"readOnly": true,
|
6046
|
-
"type": [
|
6047
|
-
"string"
|
6048
|
-
]
|
6049
|
-
},
|
6050
|
-
"process_tier": {
|
6051
|
-
"description": "application process tier",
|
6052
|
-
"enum": [
|
6053
|
-
"production",
|
6054
|
-
"free",
|
6055
|
-
"hobby",
|
6056
|
-
"private"
|
6057
|
-
],
|
6058
|
-
"example": "production",
|
6059
|
-
"readOnly": true,
|
6060
|
-
"type": [
|
6061
|
-
"string"
|
6062
|
-
]
|
6063
|
-
},
|
6064
|
-
"app": {
|
6065
|
-
"description": "app being described by the formation-set",
|
6066
|
-
"properties": {
|
6067
|
-
"name": {
|
6068
|
-
"$ref": "#/definitions/app/definitions/name"
|
6069
|
-
},
|
6070
|
-
"id": {
|
6071
|
-
"$ref": "#/definitions/app/definitions/id"
|
6072
|
-
}
|
6073
|
-
},
|
6074
|
-
"type": [
|
6075
|
-
"object"
|
6076
|
-
]
|
6077
|
-
},
|
6078
|
-
"updated_at": {
|
6079
|
-
"description": "last time fomation-set was updated",
|
6080
|
-
"example": "2012-01-01T12:00:00Z",
|
6081
|
-
"format": "date-time",
|
6082
|
-
"readOnly": true,
|
6083
|
-
"type": [
|
6084
|
-
"string"
|
6085
|
-
]
|
6086
|
-
}
|
6087
|
-
}
|
6088
|
-
},
|
6089
6167
|
"app-setup": {
|
6090
6168
|
"description": "An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.",
|
6091
6169
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -7413,9 +7491,10 @@ module PlatformAPI
|
|
7413
7491
|
"description": "web URL of app",
|
7414
7492
|
"example": "https://example.herokuapp.com/",
|
7415
7493
|
"format": "uri",
|
7416
|
-
"pattern": "^https?://[a-z][a-z0-9-]{3,
|
7494
|
+
"pattern": "^https?://[a-z][a-z0-9-]{3,43}\\.herokuapp\\.com/$",
|
7417
7495
|
"readOnly": true,
|
7418
7496
|
"type": [
|
7497
|
+
"null",
|
7419
7498
|
"string"
|
7420
7499
|
]
|
7421
7500
|
},
|
@@ -8068,7 +8147,15 @@ module PlatformAPI
|
|
8068
8147
|
"description": "A build represents the process of transforming a code tarball into a slug",
|
8069
8148
|
"title": "Heroku Build API - Build",
|
8070
8149
|
"stability": "production",
|
8071
|
-
"strictProperties":
|
8150
|
+
"strictProperties": false,
|
8151
|
+
"required": [
|
8152
|
+
"created_at",
|
8153
|
+
"id",
|
8154
|
+
"source_blob",
|
8155
|
+
"status",
|
8156
|
+
"updated_at",
|
8157
|
+
"user"
|
8158
|
+
],
|
8072
8159
|
"type": [
|
8073
8160
|
"object"
|
8074
8161
|
],
|
@@ -8191,6 +8278,15 @@ module PlatformAPI
|
|
8191
8278
|
"string",
|
8192
8279
|
"null"
|
8193
8280
|
]
|
8281
|
+
},
|
8282
|
+
"version_description": {
|
8283
|
+
"description": "Version description of the gzipped tarball.",
|
8284
|
+
"example": "* Fake User: Change session key",
|
8285
|
+
"readOnly": true,
|
8286
|
+
"type": [
|
8287
|
+
"string",
|
8288
|
+
"null"
|
8289
|
+
]
|
8194
8290
|
}
|
8195
8291
|
},
|
8196
8292
|
"strictProperties": true,
|
@@ -8200,7 +8296,7 @@ module PlatformAPI
|
|
8200
8296
|
},
|
8201
8297
|
"stack": {
|
8202
8298
|
"description": "stack of build",
|
8203
|
-
"example": "heroku-
|
8299
|
+
"example": "heroku-22",
|
8204
8300
|
"readOnly": true,
|
8205
8301
|
"type": [
|
8206
8302
|
"string"
|
@@ -8291,6 +8387,16 @@ module PlatformAPI
|
|
8291
8387
|
"method": "DELETE",
|
8292
8388
|
"rel": "empty",
|
8293
8389
|
"title": "Delete cache"
|
8390
|
+
},
|
8391
|
+
{
|
8392
|
+
"description": "Cancel running build.",
|
8393
|
+
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}",
|
8394
|
+
"method": "DELETE",
|
8395
|
+
"rel": "self",
|
8396
|
+
"targetSchema": {
|
8397
|
+
"$ref": "#/definitions/build"
|
8398
|
+
},
|
8399
|
+
"title": "Cancel"
|
8294
8400
|
}
|
8295
8401
|
],
|
8296
8402
|
"properties": {
|
@@ -9235,7 +9341,7 @@ module PlatformAPI
|
|
9235
9341
|
},
|
9236
9342
|
"name": {
|
9237
9343
|
"description": "the name of this dyno-size",
|
9238
|
-
"example": "
|
9344
|
+
"example": "eco",
|
9239
9345
|
"readOnly": true,
|
9240
9346
|
"type": [
|
9241
9347
|
"string"
|
@@ -9268,13 +9374,22 @@ module PlatformAPI
|
|
9268
9374
|
}
|
9269
9375
|
},
|
9270
9376
|
"dyno_units": {
|
9271
|
-
"
|
9377
|
+
"deprecated": true,
|
9378
|
+
"description": "deprecated. See precise_dyno_units instead",
|
9272
9379
|
"example": 0,
|
9273
9380
|
"readOnly": true,
|
9274
9381
|
"type": [
|
9275
9382
|
"integer"
|
9276
9383
|
]
|
9277
9384
|
},
|
9385
|
+
"precise_dyno_units": {
|
9386
|
+
"description": "unit of consumption for Heroku Enterprise customers to 2 decimal places",
|
9387
|
+
"example": 0.28,
|
9388
|
+
"readOnly": true,
|
9389
|
+
"type": [
|
9390
|
+
"number"
|
9391
|
+
]
|
9392
|
+
},
|
9278
9393
|
"private_space_only": {
|
9279
9394
|
"description": "whether this dyno can only be provisioned in a private space",
|
9280
9395
|
"example": false,
|
@@ -9324,6 +9439,9 @@ module PlatformAPI
|
|
9324
9439
|
"dyno_units": {
|
9325
9440
|
"$ref": "#/definitions/dyno-size/definitions/dyno_units"
|
9326
9441
|
},
|
9442
|
+
"precise_dyno_units": {
|
9443
|
+
"$ref": "#/definitions/dyno-size/definitions/precise_dyno_units"
|
9444
|
+
},
|
9327
9445
|
"id": {
|
9328
9446
|
"$ref": "#/definitions/dyno-size/definitions/id"
|
9329
9447
|
},
|
@@ -9439,7 +9557,7 @@ module PlatformAPI
|
|
9439
9557
|
]
|
9440
9558
|
},
|
9441
9559
|
"size": {
|
9442
|
-
"description": "dyno size
|
9560
|
+
"description": "dyno size",
|
9443
9561
|
"example": "standard-1X",
|
9444
9562
|
"readOnly": false,
|
9445
9563
|
"type": [
|
@@ -10341,6 +10459,9 @@ module PlatformAPI
|
|
10341
10459
|
"anyOf": [
|
10342
10460
|
{
|
10343
10461
|
"$ref": "#/definitions/enterprise-account/definitions/id"
|
10462
|
+
},
|
10463
|
+
{
|
10464
|
+
"$ref": "#/definitions/enterprise-account/definitions/name"
|
10344
10465
|
}
|
10345
10466
|
]
|
10346
10467
|
},
|
@@ -10423,6 +10544,9 @@ module PlatformAPI
|
|
10423
10544
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
10424
10545
|
"method": "GET",
|
10425
10546
|
"rel": "self",
|
10547
|
+
"targetSchema": {
|
10548
|
+
"$ref": "#/definitions/enterprise-account"
|
10549
|
+
},
|
10426
10550
|
"title": "Info"
|
10427
10551
|
},
|
10428
10552
|
{
|
@@ -10588,7 +10712,7 @@ module PlatformAPI
|
|
10588
10712
|
]
|
10589
10713
|
},
|
10590
10714
|
"size": {
|
10591
|
-
"description": "dyno size
|
10715
|
+
"description": "dyno size",
|
10592
10716
|
"example": "standard-1X",
|
10593
10717
|
"readOnly": false,
|
10594
10718
|
"type": [
|
@@ -10762,7 +10886,7 @@ module PlatformAPI
|
|
10762
10886
|
}
|
10763
10887
|
},
|
10764
10888
|
"identity-provider": {
|
10765
|
-
"description": "Identity Providers represent the SAML configuration of an Enterprise
|
10889
|
+
"description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
|
10766
10890
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
10767
10891
|
"stability": "production",
|
10768
10892
|
"strictProperties": true,
|
@@ -11265,6 +11389,9 @@ module PlatformAPI
|
|
11265
11389
|
"href": "/account/invoice-address",
|
11266
11390
|
"method": "GET",
|
11267
11391
|
"rel": "self",
|
11392
|
+
"targetSchema": {
|
11393
|
+
"$ref": "#/definitions/invoice-address"
|
11394
|
+
},
|
11268
11395
|
"title": "info"
|
11269
11396
|
},
|
11270
11397
|
{
|
@@ -11303,6 +11430,9 @@ module PlatformAPI
|
|
11303
11430
|
"type": [
|
11304
11431
|
"object"
|
11305
11432
|
]
|
11433
|
+
},
|
11434
|
+
"targetSchema": {
|
11435
|
+
"$ref": "#/definitions/invoice-address"
|
11306
11436
|
}
|
11307
11437
|
}
|
11308
11438
|
],
|
@@ -11643,7 +11773,11 @@ module PlatformAPI
|
|
11643
11773
|
"description": "add-on that created the drain",
|
11644
11774
|
"example": {
|
11645
11775
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
11646
|
-
"name": "singing-swiftly-1242"
|
11776
|
+
"name": "singing-swiftly-1242",
|
11777
|
+
"app": {
|
11778
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
11779
|
+
"name": "example"
|
11780
|
+
}
|
11647
11781
|
},
|
11648
11782
|
"properties": {
|
11649
11783
|
"id": {
|
@@ -11651,6 +11785,21 @@ module PlatformAPI
|
|
11651
11785
|
},
|
11652
11786
|
"name": {
|
11653
11787
|
"$ref": "#/definitions/add-on/definitions/name"
|
11788
|
+
},
|
11789
|
+
"app": {
|
11790
|
+
"description": "billing application associated with this add-on",
|
11791
|
+
"type": [
|
11792
|
+
"object"
|
11793
|
+
],
|
11794
|
+
"properties": {
|
11795
|
+
"id": {
|
11796
|
+
"$ref": "#/definitions/app/definitions/id"
|
11797
|
+
},
|
11798
|
+
"name": {
|
11799
|
+
"$ref": "#/definitions/app/definitions/name"
|
11800
|
+
}
|
11801
|
+
},
|
11802
|
+
"strictProperties": true
|
11654
11803
|
}
|
11655
11804
|
},
|
11656
11805
|
"readOnly": true,
|
@@ -11659,6 +11808,27 @@ module PlatformAPI
|
|
11659
11808
|
"null"
|
11660
11809
|
]
|
11661
11810
|
},
|
11811
|
+
"app": {
|
11812
|
+
"description": "application that is attached to this drain",
|
11813
|
+
"example": {
|
11814
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
11815
|
+
"name": "example"
|
11816
|
+
},
|
11817
|
+
"properties": {
|
11818
|
+
"id": {
|
11819
|
+
"$ref": "#/definitions/app/definitions/id"
|
11820
|
+
},
|
11821
|
+
"name": {
|
11822
|
+
"$ref": "#/definitions/app/definitions/name"
|
11823
|
+
}
|
11824
|
+
},
|
11825
|
+
"strictProperties": true,
|
11826
|
+
"readOnly": true,
|
11827
|
+
"type": [
|
11828
|
+
"object",
|
11829
|
+
"null"
|
11830
|
+
]
|
11831
|
+
},
|
11662
11832
|
"created_at": {
|
11663
11833
|
"description": "when log drain was created",
|
11664
11834
|
"example": "2012-01-01T12:00:00Z",
|
@@ -11825,6 +11995,9 @@ module PlatformAPI
|
|
11825
11995
|
"addon": {
|
11826
11996
|
"$ref": "#/definitions/log-drain/definitions/addon"
|
11827
11997
|
},
|
11998
|
+
"app": {
|
11999
|
+
"$ref": "#/definitions/log-drain/definitions/app"
|
12000
|
+
},
|
11828
12001
|
"created_at": {
|
11829
12002
|
"$ref": "#/definitions/log-drain/definitions/created_at"
|
11830
12003
|
},
|
@@ -12344,7 +12517,7 @@ module PlatformAPI
|
|
12344
12517
|
"title": "Delete"
|
12345
12518
|
},
|
12346
12519
|
{
|
12347
|
-
"description": "Info for an OAuth client",
|
12520
|
+
"description": "Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.",
|
12348
12521
|
"href": "/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}",
|
12349
12522
|
"method": "GET",
|
12350
12523
|
"rel": "self",
|
@@ -12526,7 +12699,7 @@ module PlatformAPI
|
|
12526
12699
|
},
|
12527
12700
|
"token": {
|
12528
12701
|
"description": "contents of the token to be used for authorization",
|
12529
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
12702
|
+
"example": "HRKU-01234567-89ab-cdef-0123-456789abcdef",
|
12530
12703
|
"readOnly": true,
|
12531
12704
|
"type": [
|
12532
12705
|
"string"
|
@@ -12724,9 +12897,11 @@ module PlatformAPI
|
|
12724
12897
|
"outbound-ruleset": {
|
12725
12898
|
"description": "An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ",
|
12726
12899
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
12727
|
-
"stability": "
|
12900
|
+
"stability": "deprecation",
|
12728
12901
|
"strictProperties": true,
|
12729
12902
|
"title": "Heroku Platform API - Outbound Ruleset",
|
12903
|
+
"deprecated_at": "2024-04-30",
|
12904
|
+
"deactivate_on": "2024-06-03",
|
12730
12905
|
"type": [
|
12731
12906
|
"object"
|
12732
12907
|
],
|
@@ -12957,10 +13132,16 @@ module PlatformAPI
|
|
12957
13132
|
"$ref": "#/definitions/account/definitions/email"
|
12958
13133
|
}
|
12959
13134
|
},
|
13135
|
+
"required": [
|
13136
|
+
"email"
|
13137
|
+
],
|
12960
13138
|
"type": [
|
12961
13139
|
"object"
|
12962
13140
|
]
|
12963
13141
|
},
|
13142
|
+
"targetSchema": {
|
13143
|
+
"$ref": "#/definitions/password-reset"
|
13144
|
+
},
|
12964
13145
|
"title": "Reset Password"
|
12965
13146
|
},
|
12966
13147
|
{
|
@@ -12977,10 +13158,17 @@ module PlatformAPI
|
|
12977
13158
|
"$ref": "#/definitions/password-reset/definitions/password_confirmation"
|
12978
13159
|
}
|
12979
13160
|
},
|
13161
|
+
"required": [
|
13162
|
+
"password",
|
13163
|
+
"password_confirmation"
|
13164
|
+
],
|
12980
13165
|
"type": [
|
12981
13166
|
"object"
|
12982
13167
|
]
|
12983
13168
|
},
|
13169
|
+
"targetSchema": {
|
13170
|
+
"$ref": "#/definitions/password-reset"
|
13171
|
+
},
|
12984
13172
|
"title": "Complete Reset Password"
|
12985
13173
|
}
|
12986
13174
|
],
|
@@ -13210,14 +13398,20 @@ module PlatformAPI
|
|
13210
13398
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}/actions/accept",
|
13211
13399
|
"method": "POST",
|
13212
13400
|
"rel": "empty",
|
13213
|
-
"title": "Accept"
|
13401
|
+
"title": "Accept",
|
13402
|
+
"targetSchema": {
|
13403
|
+
"$ref": "#/definitions/peering"
|
13404
|
+
}
|
13214
13405
|
},
|
13215
13406
|
{
|
13216
13407
|
"description": "Destroy an active peering connection with a private space.",
|
13217
13408
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
|
13218
13409
|
"rel": "empty",
|
13219
13410
|
"method": "DELETE",
|
13220
|
-
"title": "Destroy"
|
13411
|
+
"title": "Destroy",
|
13412
|
+
"targetSchema": {
|
13413
|
+
"$ref": "#/definitions/peering"
|
13414
|
+
}
|
13221
13415
|
},
|
13222
13416
|
{
|
13223
13417
|
"description": "Fetch information for existing peering connection",
|
@@ -14843,12 +15037,14 @@ module PlatformAPI
|
|
14843
15037
|
"ap-southeast-1",
|
14844
15038
|
"ap-southeast-2",
|
14845
15039
|
"eu-central-1",
|
15040
|
+
"eu-west-2",
|
14846
15041
|
"ap-northeast-2",
|
14847
15042
|
"ap-northeast-1",
|
14848
15043
|
"us-east-1",
|
14849
15044
|
"sa-east-1",
|
14850
15045
|
"us-west-1",
|
14851
|
-
"us-west-2"
|
15046
|
+
"us-west-2",
|
15047
|
+
"ca-central-1"
|
14852
15048
|
]
|
14853
15049
|
}
|
14854
15050
|
},
|
@@ -16871,7 +17067,7 @@ module PlatformAPI
|
|
16871
17067
|
"space": {
|
16872
17068
|
"description": "A space is an isolated, highly available, secure app execution environment.",
|
16873
17069
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
16874
|
-
"stability": "
|
17070
|
+
"stability": "production",
|
16875
17071
|
"strictProperties": true,
|
16876
17072
|
"title": "Heroku Platform API - Space",
|
16877
17073
|
"type": [
|
@@ -17534,11 +17730,7 @@ module PlatformAPI
|
|
17534
17730
|
]
|
17535
17731
|
},
|
17536
17732
|
"identity": {
|
17537
|
-
"
|
17538
|
-
{
|
17539
|
-
"$ref": "#/definitions/app/definitions/name"
|
17540
|
-
}
|
17541
|
-
]
|
17733
|
+
"$ref": "#/definitions/app/definitions/name"
|
17542
17734
|
},
|
17543
17735
|
"internal_routing": {
|
17544
17736
|
"default": false,
|
@@ -17604,6 +17796,9 @@ module PlatformAPI
|
|
17604
17796
|
"object"
|
17605
17797
|
]
|
17606
17798
|
},
|
17799
|
+
"targetSchema": {
|
17800
|
+
"$ref": "#/definitions/team-app"
|
17801
|
+
},
|
17607
17802
|
"title": "Create"
|
17608
17803
|
},
|
17609
17804
|
{
|
@@ -17611,6 +17806,9 @@ module PlatformAPI
|
|
17611
17806
|
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
17612
17807
|
"method": "GET",
|
17613
17808
|
"rel": "self",
|
17809
|
+
"targetSchema": {
|
17810
|
+
"$ref": "#/definitions/team-app"
|
17811
|
+
},
|
17614
17812
|
"title": "Info"
|
17615
17813
|
},
|
17616
17814
|
{
|
@@ -18014,6 +18212,58 @@ module PlatformAPI
|
|
18014
18212
|
}
|
18015
18213
|
}
|
18016
18214
|
},
|
18215
|
+
"team-delinquency": {
|
18216
|
+
"description": "A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.",
|
18217
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
18218
|
+
"stability": "development",
|
18219
|
+
"strictProperties": true,
|
18220
|
+
"title": "Heroku Platform API - Team Delinquency",
|
18221
|
+
"type": [
|
18222
|
+
"object"
|
18223
|
+
],
|
18224
|
+
"definitions": {
|
18225
|
+
"scheduled_suspension_time": {
|
18226
|
+
"description": "scheduled time of when we will suspend your team due to delinquency",
|
18227
|
+
"example": "2024-01-01T12:00:00Z",
|
18228
|
+
"format": "date-time",
|
18229
|
+
"readOnly": true,
|
18230
|
+
"type": [
|
18231
|
+
"string",
|
18232
|
+
"null"
|
18233
|
+
]
|
18234
|
+
},
|
18235
|
+
"scheduled_deletion_time": {
|
18236
|
+
"description": "scheduled time of when we will delete your team due to delinquency",
|
18237
|
+
"example": "2024-01-01T12:00:00Z",
|
18238
|
+
"format": "date-time",
|
18239
|
+
"readOnly": true,
|
18240
|
+
"type": [
|
18241
|
+
"string",
|
18242
|
+
"null"
|
18243
|
+
]
|
18244
|
+
}
|
18245
|
+
},
|
18246
|
+
"links": [
|
18247
|
+
{
|
18248
|
+
"description": "Team delinquency information.",
|
18249
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/delinquency",
|
18250
|
+
"method": "GET",
|
18251
|
+
"rel": "self",
|
18252
|
+
"targetSchema": {
|
18253
|
+
"$ref": "#/definitions/team-delinquency"
|
18254
|
+
},
|
18255
|
+
"title": "Info"
|
18256
|
+
}
|
18257
|
+
],
|
18258
|
+
"properties": {
|
18259
|
+
"scheduled_suspension_time": {
|
18260
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_suspension_time"
|
18261
|
+
},
|
18262
|
+
"scheduled_deletion_time": {
|
18263
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_deletion_time"
|
18264
|
+
}
|
18265
|
+
}
|
18266
|
+
},
|
18017
18267
|
"team-feature": {
|
18018
18268
|
"description": "A team feature represents a feature enabled on a team account.",
|
18019
18269
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -18269,6 +18519,9 @@ module PlatformAPI
|
|
18269
18519
|
"type": [
|
18270
18520
|
"object"
|
18271
18521
|
]
|
18522
|
+
},
|
18523
|
+
"targetSchema": {
|
18524
|
+
"$ref": "#/definitions/team-invitation"
|
18272
18525
|
}
|
18273
18526
|
},
|
18274
18527
|
{
|
@@ -18276,7 +18529,10 @@ module PlatformAPI
|
|
18276
18529
|
"title": "Revoke",
|
18277
18530
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Fidentity)}",
|
18278
18531
|
"method": "DELETE",
|
18279
|
-
"rel": "self"
|
18532
|
+
"rel": "self",
|
18533
|
+
"targetSchema": {
|
18534
|
+
"$ref": "#/definitions/team-invitation"
|
18535
|
+
}
|
18280
18536
|
},
|
18281
18537
|
{
|
18282
18538
|
"description": "Get an invitation by its token",
|
@@ -18671,7 +18927,7 @@ module PlatformAPI
|
|
18671
18927
|
]
|
18672
18928
|
},
|
18673
18929
|
"two_factor_authentication": {
|
18674
|
-
"description": "whether the
|
18930
|
+
"description": "whether the team member has two factor authentication enabled",
|
18675
18931
|
"example": true,
|
18676
18932
|
"readOnly": true,
|
18677
18933
|
"type": [
|
@@ -19484,6 +19740,9 @@ module PlatformAPI
|
|
19484
19740
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
19485
19741
|
"method": "GET",
|
19486
19742
|
"rel": "self",
|
19743
|
+
"targetSchema": {
|
19744
|
+
"$ref": "#/definitions/team"
|
19745
|
+
},
|
19487
19746
|
"title": "Info"
|
19488
19747
|
},
|
19489
19748
|
{
|
@@ -20751,6 +21010,9 @@ module PlatformAPI
|
|
20751
21010
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/vpn-connections/{(%23%2Fdefinitions%2Fvpn-connection%2Fdefinitions%2Fidentity)}",
|
20752
21011
|
"rel": "empty",
|
20753
21012
|
"method": "DELETE",
|
21013
|
+
"targetSchema": {
|
21014
|
+
"$ref": "#/definitions/vpn-connection"
|
21015
|
+
},
|
20754
21016
|
"title": "Destroy"
|
20755
21017
|
},
|
20756
21018
|
{
|
@@ -20805,6 +21067,9 @@ module PlatformAPI
|
|
20805
21067
|
}
|
20806
21068
|
},
|
20807
21069
|
"properties": {
|
21070
|
+
"account-delinquency": {
|
21071
|
+
"$ref": "#/definitions/account-delinquency"
|
21072
|
+
},
|
20808
21073
|
"account-feature": {
|
20809
21074
|
"$ref": "#/definitions/account-feature"
|
20810
21075
|
},
|
@@ -20847,9 +21112,6 @@ module PlatformAPI
|
|
20847
21112
|
"app-feature": {
|
20848
21113
|
"$ref": "#/definitions/app-feature"
|
20849
21114
|
},
|
20850
|
-
"app-formation-set": {
|
20851
|
-
"$ref": "#/definitions/app-formation-set"
|
20852
|
-
},
|
20853
21115
|
"app-setup": {
|
20854
21116
|
"$ref": "#/definitions/app-setup"
|
20855
21117
|
},
|
@@ -21057,6 +21319,9 @@ module PlatformAPI
|
|
21057
21319
|
"team-daily-usage": {
|
21058
21320
|
"$ref": "#/definitions/team-daily-usage"
|
21059
21321
|
},
|
21322
|
+
"team-delinquency": {
|
21323
|
+
"$ref": "#/definitions/team-delinquency"
|
21324
|
+
},
|
21060
21325
|
"team-feature": {
|
21061
21326
|
"$ref": "#/definitions/team-feature"
|
21062
21327
|
},
|