platform-api 3.3.0 → 3.6.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 +12 -0
- data/CODEOWNERS +2 -0
- data/README.md +6 -6
- data/Rakefile +2 -1
- data/lib/platform-api/client.rb +1212 -1613
- data/lib/platform-api/version.rb +1 -1
- data/schema.json +1061 -1365
- metadata +4 -3
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.6.0"}
|
|
87
87
|
{
|
|
88
88
|
default_headers: default_headers,
|
|
89
89
|
url: "https://api.heroku.com"
|
|
@@ -196,13 +196,6 @@ module PlatformAPI
|
|
|
196
196
|
@app_feature_resource ||= AppFeature.new(@client)
|
|
197
197
|
end
|
|
198
198
|
|
|
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
199
|
# 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
200
|
#
|
|
208
201
|
# @return [AppSetup]
|
|
@@ -315,6 +308,13 @@ module PlatformAPI
|
|
|
315
308
|
@dyno_resource ||= Dyno.new(@client)
|
|
316
309
|
end
|
|
317
310
|
|
|
311
|
+
# Usage for an enterprise account at a daily resolution.
|
|
312
|
+
#
|
|
313
|
+
# @return [EnterpriseAccountDailyUsage]
|
|
314
|
+
def enterprise_account_daily_usage
|
|
315
|
+
@enterprise_account_daily_usage_resource ||= EnterpriseAccountDailyUsage.new(@client)
|
|
316
|
+
end
|
|
317
|
+
|
|
318
318
|
# Enterprise account members are users with access to an enterprise account.
|
|
319
319
|
#
|
|
320
320
|
# @return [EnterpriseAccountMember]
|
|
@@ -322,18 +322,11 @@ module PlatformAPI
|
|
|
322
322
|
@enterprise_account_member_resource ||= EnterpriseAccountMember.new(@client)
|
|
323
323
|
end
|
|
324
324
|
|
|
325
|
-
# Usage for an enterprise account at a daily resolution.
|
|
326
|
-
#
|
|
327
|
-
# @return [EnterpriseAccountUsageDaily]
|
|
328
|
-
def enterprise_account_usage_daily
|
|
329
|
-
@enterprise_account_usage_daily_resource ||= EnterpriseAccountUsageDaily.new(@client)
|
|
330
|
-
end
|
|
331
|
-
|
|
332
325
|
# Usage for an enterprise account at a monthly resolution.
|
|
333
326
|
#
|
|
334
|
-
# @return [
|
|
335
|
-
def
|
|
336
|
-
@
|
|
327
|
+
# @return [EnterpriseAccountMonthlyUsage]
|
|
328
|
+
def enterprise_account_monthly_usage
|
|
329
|
+
@enterprise_account_monthly_usage_resource ||= EnterpriseAccountMonthlyUsage.new(@client)
|
|
337
330
|
end
|
|
338
331
|
|
|
339
332
|
# Enterprise accounts allow companies to manage their development teams and billing.
|
|
@@ -357,7 +350,7 @@ module PlatformAPI
|
|
|
357
350
|
@formation_resource ||= Formation.new(@client)
|
|
358
351
|
end
|
|
359
352
|
|
|
360
|
-
# Identity Providers represent the SAML configuration of an Team.
|
|
353
|
+
# Identity Providers represent the SAML configuration of an Enterprise Account or Team.
|
|
361
354
|
#
|
|
362
355
|
# @return [IdentityProvider]
|
|
363
356
|
def identity_provider
|
|
@@ -637,20 +630,13 @@ module PlatformAPI
|
|
|
637
630
|
@space_transfer_resource ||= SpaceTransfer.new(@client)
|
|
638
631
|
end
|
|
639
632
|
|
|
640
|
-
# A space is an isolated, highly available, secure app execution
|
|
633
|
+
# A space is an isolated, highly available, secure app execution environment.
|
|
641
634
|
#
|
|
642
635
|
# @return [Space]
|
|
643
636
|
def space
|
|
644
637
|
@space_resource ||= Space.new(@client)
|
|
645
638
|
end
|
|
646
639
|
|
|
647
|
-
# [SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` add-on installed before it can provision an SSL Endpoint using these APIs.
|
|
648
|
-
#
|
|
649
|
-
# @return [SSLEndpoint]
|
|
650
|
-
def ssl_endpoint
|
|
651
|
-
@ssl_endpoint_resource ||= SSLEndpoint.new(@client)
|
|
652
|
-
end
|
|
653
|
-
|
|
654
640
|
# Stacks are the different application execution environments available in the Heroku platform.
|
|
655
641
|
#
|
|
656
642
|
# @return [Stack]
|
|
@@ -686,6 +672,13 @@ module PlatformAPI
|
|
|
686
672
|
@team_app_resource ||= TeamApp.new(@client)
|
|
687
673
|
end
|
|
688
674
|
|
|
675
|
+
# Usage for an enterprise team at a daily resolution.
|
|
676
|
+
#
|
|
677
|
+
# @return [TeamDailyUsage]
|
|
678
|
+
def team_daily_usage
|
|
679
|
+
@team_daily_usage_resource ||= TeamDailyUsage.new(@client)
|
|
680
|
+
end
|
|
681
|
+
|
|
689
682
|
# A team feature represents a feature enabled on a team account.
|
|
690
683
|
#
|
|
691
684
|
# @return [TeamFeature]
|
|
@@ -714,6 +707,13 @@ module PlatformAPI
|
|
|
714
707
|
@team_member_resource ||= TeamMember.new(@client)
|
|
715
708
|
end
|
|
716
709
|
|
|
710
|
+
# Usage for an enterprise team at a monthly resolution.
|
|
711
|
+
#
|
|
712
|
+
# @return [TeamMonthlyUsage]
|
|
713
|
+
def team_monthly_usage
|
|
714
|
+
@team_monthly_usage_resource ||= TeamMonthlyUsage.new(@client)
|
|
715
|
+
end
|
|
716
|
+
|
|
717
717
|
# Tracks a Team's Preferences
|
|
718
718
|
#
|
|
719
719
|
# @return [TeamPreferences]
|
|
@@ -721,27 +721,13 @@ module PlatformAPI
|
|
|
721
721
|
@team_preferences_resource ||= TeamPreferences.new(@client)
|
|
722
722
|
end
|
|
723
723
|
|
|
724
|
-
# A space is an isolated, highly available, secure app execution
|
|
724
|
+
# A space is an isolated, highly available, secure app execution environment.
|
|
725
725
|
#
|
|
726
726
|
# @return [TeamSpace]
|
|
727
727
|
def team_space
|
|
728
728
|
@team_space_resource ||= TeamSpace.new(@client)
|
|
729
729
|
end
|
|
730
730
|
|
|
731
|
-
# Usage for an enterprise team at a daily resolution.
|
|
732
|
-
#
|
|
733
|
-
# @return [TeamUsageDaily]
|
|
734
|
-
def team_usage_daily
|
|
735
|
-
@team_usage_daily_resource ||= TeamUsageDaily.new(@client)
|
|
736
|
-
end
|
|
737
|
-
|
|
738
|
-
# Usage for an enterprise team at a monthly resolution.
|
|
739
|
-
#
|
|
740
|
-
# @return [TeamUsageMonthly]
|
|
741
|
-
def team_usage_monthly
|
|
742
|
-
@team_usage_monthly_resource ||= TeamUsageMonthly.new(@client)
|
|
743
|
-
end
|
|
744
|
-
|
|
745
731
|
# Teams allow you to manage access to a shared group of applications and other resources.
|
|
746
732
|
#
|
|
747
733
|
# @return [Team]
|
|
@@ -783,13 +769,6 @@ module PlatformAPI
|
|
|
783
769
|
def vpn_connection
|
|
784
770
|
@vpn_connection_resource ||= VpnConnection.new(@client)
|
|
785
771
|
end
|
|
786
|
-
|
|
787
|
-
# Entities that have been whitelisted to be used by a Team. Deprecated in favor of [Allowed Add-on Service](#allowed-add-on-service) endpoints.
|
|
788
|
-
#
|
|
789
|
-
# @return [WhitelistedAddonService]
|
|
790
|
-
def whitelisted_addon_service
|
|
791
|
-
@whitelisted_addon_service_resource ||= WhitelistedAddonService.new(@client)
|
|
792
|
-
end
|
|
793
772
|
end
|
|
794
773
|
|
|
795
774
|
private
|
|
@@ -839,7 +818,7 @@ module PlatformAPI
|
|
|
839
818
|
@client.account.update(body)
|
|
840
819
|
end
|
|
841
820
|
|
|
842
|
-
# Delete account. Note that this action cannot be undone.
|
|
821
|
+
# Delete account. Note that this action cannot be undone. Note: This endpoint requires the HTTP_HEROKU_PASSWORD or HTTP_HEROKU_PASSWORD_BASE64 header be set correctly for the user account.
|
|
843
822
|
def delete()
|
|
844
823
|
@client.account.delete()
|
|
845
824
|
end
|
|
@@ -859,7 +838,7 @@ module PlatformAPI
|
|
|
859
838
|
@client.account.update_by_user(account_email_or_account_id_or_account_self, body)
|
|
860
839
|
end
|
|
861
840
|
|
|
862
|
-
# Delete account. Note that this action cannot be undone.
|
|
841
|
+
# Delete account. Note that this action cannot be undone. Note: This endpoint requires the HTTP_HEROKU_PASSWORD or HTTP_HEROKU_PASSWORD_BASE64 header be set correctly for the user account.
|
|
863
842
|
#
|
|
864
843
|
# @param account_email_or_account_id_or_account_self: unique email address of account or unique identifier of an account or Implicit reference to currently authorized user
|
|
865
844
|
def delete_by_user(account_email_or_account_id_or_account_self)
|
|
@@ -1256,13 +1235,6 @@ module PlatformAPI
|
|
|
1256
1235
|
end
|
|
1257
1236
|
end
|
|
1258
1237
|
|
|
1259
|
-
# App formation set describes the combination of process types with their quantities and sizes as well as application process tier
|
|
1260
|
-
class AppFormationSet
|
|
1261
|
-
def initialize(client)
|
|
1262
|
-
@client = client
|
|
1263
|
-
end
|
|
1264
|
-
end
|
|
1265
|
-
|
|
1266
1238
|
# An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
|
|
1267
1239
|
class AppSetup
|
|
1268
1240
|
def initialize(client)
|
|
@@ -1514,7 +1486,7 @@ module PlatformAPI
|
|
|
1514
1486
|
@client = client
|
|
1515
1487
|
end
|
|
1516
1488
|
|
|
1517
|
-
# List existing events. Returns all events for one
|
|
1489
|
+
# 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.
|
|
1518
1490
|
#
|
|
1519
1491
|
# @param enterprise_account_id: unique identifier of the enterprise account
|
|
1520
1492
|
def list(enterprise_account_id)
|
|
@@ -1557,6 +1529,14 @@ module PlatformAPI
|
|
|
1557
1529
|
def delete_cache(app_id_or_app_name)
|
|
1558
1530
|
@client.build.delete_cache(app_id_or_app_name)
|
|
1559
1531
|
end
|
|
1532
|
+
|
|
1533
|
+
# Cancel running build.
|
|
1534
|
+
#
|
|
1535
|
+
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
1536
|
+
# @param build_id: unique identifier of build
|
|
1537
|
+
def cancel(app_id_or_app_name, build_id)
|
|
1538
|
+
@client.build.cancel(app_id_or_app_name, build_id)
|
|
1539
|
+
end
|
|
1560
1540
|
end
|
|
1561
1541
|
|
|
1562
1542
|
# A buildpack installation represents a buildpack that will be run against an app.
|
|
@@ -1681,14 +1661,6 @@ module PlatformAPI
|
|
|
1681
1661
|
@client = client
|
|
1682
1662
|
end
|
|
1683
1663
|
|
|
1684
|
-
# Create a new domain. Deprecated in favor of this same endpoint, but with a new required attribute of `sni_endpoint`. During the transitional phase sni_endpoint can be omitted entirely (current behavior), can be a valid id, or can be null which will skip auto-association.
|
|
1685
|
-
#
|
|
1686
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
1687
|
-
# @param body: the object to pass as the request payload
|
|
1688
|
-
def create_deprecated(app_id_or_app_name, body = {})
|
|
1689
|
-
@client.domain.create_deprecated(app_id_or_app_name, body)
|
|
1690
|
-
end
|
|
1691
|
-
|
|
1692
1664
|
# Create a new domain.
|
|
1693
1665
|
#
|
|
1694
1666
|
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
@@ -1802,6 +1774,22 @@ module PlatformAPI
|
|
|
1802
1774
|
end
|
|
1803
1775
|
end
|
|
1804
1776
|
|
|
1777
|
+
# Usage for an enterprise account at a daily resolution.
|
|
1778
|
+
class EnterpriseAccountDailyUsage
|
|
1779
|
+
def initialize(client)
|
|
1780
|
+
@client = client
|
|
1781
|
+
end
|
|
1782
|
+
|
|
1783
|
+
# Retrieves usage for an enterprise account for a range of days. Start and end dates can be specified as query parameters using the date format YYYY-MM-DD. The enterprise account identifier can be found from the [enterprise account list](https://devcenter.heroku.com/articles/platform-api-reference#enterprise-account-list).
|
|
1784
|
+
|
|
1785
|
+
#
|
|
1786
|
+
# @param enterprise_account_id: unique identifier of the enterprise account
|
|
1787
|
+
# @param body: the object to pass as the request payload
|
|
1788
|
+
def info(enterprise_account_id, body = {})
|
|
1789
|
+
@client.enterprise_account_daily_usage.info(enterprise_account_id, body)
|
|
1790
|
+
end
|
|
1791
|
+
end
|
|
1792
|
+
|
|
1805
1793
|
# Enterprise account members are users with access to an enterprise account.
|
|
1806
1794
|
class EnterpriseAccountMember
|
|
1807
1795
|
def initialize(client)
|
|
@@ -1841,31 +1829,19 @@ module PlatformAPI
|
|
|
1841
1829
|
end
|
|
1842
1830
|
end
|
|
1843
1831
|
|
|
1844
|
-
# Usage for an enterprise account at a daily resolution.
|
|
1845
|
-
class EnterpriseAccountUsageDaily
|
|
1846
|
-
def initialize(client)
|
|
1847
|
-
@client = client
|
|
1848
|
-
end
|
|
1849
|
-
|
|
1850
|
-
# Retrieves usage for an enterprise account for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/enterprise-accounts/example-account/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.
|
|
1851
|
-
#
|
|
1852
|
-
# @param enterprise_account_id: unique identifier of the enterprise account
|
|
1853
|
-
def info(enterprise_account_id)
|
|
1854
|
-
@client.enterprise_account_usage_daily.info(enterprise_account_id)
|
|
1855
|
-
end
|
|
1856
|
-
end
|
|
1857
|
-
|
|
1858
1832
|
# Usage for an enterprise account at a monthly resolution.
|
|
1859
|
-
class
|
|
1833
|
+
class EnterpriseAccountMonthlyUsage
|
|
1860
1834
|
def initialize(client)
|
|
1861
1835
|
@client = client
|
|
1862
1836
|
end
|
|
1863
1837
|
|
|
1864
|
-
# Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format
|
|
1838
|
+
# Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format YYYY-MM. If no end date is specified, one month of usage is returned. The enterprise account identifier can be found from the [enterprise account list](https://devcenter.heroku.com/articles/platform-api-reference#enterprise-account-list).
|
|
1839
|
+
|
|
1865
1840
|
#
|
|
1866
1841
|
# @param enterprise_account_id: unique identifier of the enterprise account
|
|
1867
|
-
|
|
1868
|
-
|
|
1842
|
+
# @param body: the object to pass as the request payload
|
|
1843
|
+
def info(enterprise_account_id, body = {})
|
|
1844
|
+
@client.enterprise_account_monthly_usage.info(enterprise_account_id, body)
|
|
1869
1845
|
end
|
|
1870
1846
|
end
|
|
1871
1847
|
|
|
@@ -1949,7 +1925,7 @@ module PlatformAPI
|
|
|
1949
1925
|
end
|
|
1950
1926
|
end
|
|
1951
1927
|
|
|
1952
|
-
# Identity Providers represent the SAML configuration of an Team.
|
|
1928
|
+
# Identity Providers represent the SAML configuration of an Enterprise Account or Team.
|
|
1953
1929
|
class IdentityProvider
|
|
1954
1930
|
def initialize(client)
|
|
1955
1931
|
@client = client
|
|
@@ -2400,9 +2376,9 @@ module PlatformAPI
|
|
|
2400
2376
|
|
|
2401
2377
|
# List latest builds for each app in a pipeline
|
|
2402
2378
|
#
|
|
2403
|
-
# @param
|
|
2404
|
-
def list(
|
|
2405
|
-
@client.pipeline_build.list(
|
|
2379
|
+
# @param pipeline_id: unique identifier of pipeline
|
|
2380
|
+
def list(pipeline_id)
|
|
2381
|
+
@client.pipeline_build.list(pipeline_id)
|
|
2406
2382
|
end
|
|
2407
2383
|
end
|
|
2408
2384
|
|
|
@@ -2505,9 +2481,9 @@ module PlatformAPI
|
|
|
2505
2481
|
|
|
2506
2482
|
# List latest slug releases for each app in a pipeline
|
|
2507
2483
|
#
|
|
2508
|
-
# @param
|
|
2509
|
-
def list(
|
|
2510
|
-
@client.pipeline_deployment.list(
|
|
2484
|
+
# @param pipeline_id: unique identifier of pipeline
|
|
2485
|
+
def list(pipeline_id)
|
|
2486
|
+
@client.pipeline_deployment.list(pipeline_id)
|
|
2511
2487
|
end
|
|
2512
2488
|
end
|
|
2513
2489
|
|
|
@@ -2554,9 +2530,9 @@ module PlatformAPI
|
|
|
2554
2530
|
|
|
2555
2531
|
# List latest releases for each app in a pipeline
|
|
2556
2532
|
#
|
|
2557
|
-
# @param
|
|
2558
|
-
def list(
|
|
2559
|
-
@client.pipeline_release.list(
|
|
2533
|
+
# @param pipeline_id: unique identifier of pipeline
|
|
2534
|
+
def list(pipeline_id)
|
|
2535
|
+
@client.pipeline_release.list(pipeline_id)
|
|
2560
2536
|
end
|
|
2561
2537
|
end
|
|
2562
2538
|
|
|
@@ -2568,9 +2544,9 @@ module PlatformAPI
|
|
|
2568
2544
|
|
|
2569
2545
|
# The stack for a given pipeline, used for CI and Review Apps that have no stack defined in app.json.
|
|
2570
2546
|
#
|
|
2571
|
-
# @param
|
|
2572
|
-
def default_stack(
|
|
2573
|
-
@client.pipeline_stack.default_stack(
|
|
2547
|
+
# @param pipeline_id: unique identifier of pipeline
|
|
2548
|
+
def default_stack(pipeline_id)
|
|
2549
|
+
@client.pipeline_stack.default_stack(pipeline_id)
|
|
2574
2550
|
end
|
|
2575
2551
|
end
|
|
2576
2552
|
|
|
@@ -2997,7 +2973,7 @@ module PlatformAPI
|
|
|
2997
2973
|
end
|
|
2998
2974
|
end
|
|
2999
2975
|
|
|
3000
|
-
# A space is an isolated, highly available, secure app execution
|
|
2976
|
+
# A space is an isolated, highly available, secure app execution environment.
|
|
3001
2977
|
class Space
|
|
3002
2978
|
def initialize(client)
|
|
3003
2979
|
@client = client
|
|
@@ -3038,53 +3014,6 @@ module PlatformAPI
|
|
|
3038
3014
|
end
|
|
3039
3015
|
end
|
|
3040
3016
|
|
|
3041
|
-
# [SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` add-on installed before it can provision an SSL Endpoint using these APIs.
|
|
3042
|
-
class SSLEndpoint
|
|
3043
|
-
def initialize(client)
|
|
3044
|
-
@client = client
|
|
3045
|
-
end
|
|
3046
|
-
|
|
3047
|
-
# Create a new SSL endpoint.
|
|
3048
|
-
#
|
|
3049
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
3050
|
-
# @param body: the object to pass as the request payload
|
|
3051
|
-
def create(app_id_or_app_name, body = {})
|
|
3052
|
-
@client.ssl_endpoint.create(app_id_or_app_name, body)
|
|
3053
|
-
end
|
|
3054
|
-
|
|
3055
|
-
# Delete existing SSL endpoint.
|
|
3056
|
-
#
|
|
3057
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
3058
|
-
# @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
|
|
3059
|
-
def delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
|
|
3060
|
-
@client.ssl_endpoint.delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
|
|
3061
|
-
end
|
|
3062
|
-
|
|
3063
|
-
# Info for existing SSL endpoint.
|
|
3064
|
-
#
|
|
3065
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
3066
|
-
# @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
|
|
3067
|
-
def info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
|
|
3068
|
-
@client.ssl_endpoint.info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
|
|
3069
|
-
end
|
|
3070
|
-
|
|
3071
|
-
# List existing SSL endpoints.
|
|
3072
|
-
#
|
|
3073
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
3074
|
-
def list(app_id_or_app_name)
|
|
3075
|
-
@client.ssl_endpoint.list(app_id_or_app_name)
|
|
3076
|
-
end
|
|
3077
|
-
|
|
3078
|
-
# Update an existing SSL endpoint.
|
|
3079
|
-
#
|
|
3080
|
-
# @param app_id_or_app_name: unique identifier of app or unique name of app
|
|
3081
|
-
# @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
|
|
3082
|
-
# @param body: the object to pass as the request payload
|
|
3083
|
-
def update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body = {})
|
|
3084
|
-
@client.ssl_endpoint.update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body)
|
|
3085
|
-
end
|
|
3086
|
-
end
|
|
3087
|
-
|
|
3088
3017
|
# Stacks are the different application execution environments available in the Heroku platform.
|
|
3089
3018
|
class Stack
|
|
3090
3019
|
def initialize(client)
|
|
@@ -3229,6 +3158,22 @@ module PlatformAPI
|
|
|
3229
3158
|
end
|
|
3230
3159
|
end
|
|
3231
3160
|
|
|
3161
|
+
# Usage for an enterprise team at a daily resolution.
|
|
3162
|
+
class TeamDailyUsage
|
|
3163
|
+
def initialize(client)
|
|
3164
|
+
@client = client
|
|
3165
|
+
end
|
|
3166
|
+
|
|
3167
|
+
# Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format YYYY-MM-DD. The team identifier can be found from the [team list endpoint](https://devcenter.heroku.com/articles/platform-api-reference#team-list).
|
|
3168
|
+
|
|
3169
|
+
#
|
|
3170
|
+
# @param team_id: unique identifier of team
|
|
3171
|
+
# @param body: the object to pass as the request payload
|
|
3172
|
+
def info(team_id, body = {})
|
|
3173
|
+
@client.team_daily_usage.info(team_id, body)
|
|
3174
|
+
end
|
|
3175
|
+
end
|
|
3176
|
+
|
|
3232
3177
|
# A team feature represents a feature enabled on a team account.
|
|
3233
3178
|
class TeamFeature
|
|
3234
3179
|
def initialize(client)
|
|
@@ -3371,6 +3316,22 @@ module PlatformAPI
|
|
|
3371
3316
|
end
|
|
3372
3317
|
end
|
|
3373
3318
|
|
|
3319
|
+
# Usage for an enterprise team at a monthly resolution.
|
|
3320
|
+
class TeamMonthlyUsage
|
|
3321
|
+
def initialize(client)
|
|
3322
|
+
@client = client
|
|
3323
|
+
end
|
|
3324
|
+
|
|
3325
|
+
# Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date, YYYY-MM. If no end date is specified, one month of usage is returned. The team identifier can be found from the [team list endpoint](https://devcenter.heroku.com/articles/platform-api-reference#team-list).
|
|
3326
|
+
|
|
3327
|
+
#
|
|
3328
|
+
# @param team_id: unique identifier of team
|
|
3329
|
+
# @param body: the object to pass as the request payload
|
|
3330
|
+
def info(team_id, body = {})
|
|
3331
|
+
@client.team_monthly_usage.info(team_id, body)
|
|
3332
|
+
end
|
|
3333
|
+
end
|
|
3334
|
+
|
|
3374
3335
|
# Tracks a Team's Preferences
|
|
3375
3336
|
class TeamPreferences
|
|
3376
3337
|
def initialize(client)
|
|
@@ -3393,7 +3354,7 @@ module PlatformAPI
|
|
|
3393
3354
|
end
|
|
3394
3355
|
end
|
|
3395
3356
|
|
|
3396
|
-
# A space is an isolated, highly available, secure app execution
|
|
3357
|
+
# A space is an isolated, highly available, secure app execution environment.
|
|
3397
3358
|
class TeamSpace
|
|
3398
3359
|
def initialize(client)
|
|
3399
3360
|
@client = client
|
|
@@ -3407,34 +3368,6 @@ module PlatformAPI
|
|
|
3407
3368
|
end
|
|
3408
3369
|
end
|
|
3409
3370
|
|
|
3410
|
-
# Usage for an enterprise team at a daily resolution.
|
|
3411
|
-
class TeamUsageDaily
|
|
3412
|
-
def initialize(client)
|
|
3413
|
-
@client = client
|
|
3414
|
-
end
|
|
3415
|
-
|
|
3416
|
-
# Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/teams/example-team/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.
|
|
3417
|
-
#
|
|
3418
|
-
# @param team_id: unique identifier of team
|
|
3419
|
-
def info(team_id)
|
|
3420
|
-
@client.team_usage_daily.info(team_id)
|
|
3421
|
-
end
|
|
3422
|
-
end
|
|
3423
|
-
|
|
3424
|
-
# Usage for an enterprise team at a monthly resolution.
|
|
3425
|
-
class TeamUsageMonthly
|
|
3426
|
-
def initialize(client)
|
|
3427
|
-
@client = client
|
|
3428
|
-
end
|
|
3429
|
-
|
|
3430
|
-
# Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/teams/example-team/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.
|
|
3431
|
-
#
|
|
3432
|
-
# @param team_id: unique identifier of team
|
|
3433
|
-
def info(team_id)
|
|
3434
|
-
@client.team_usage_monthly.info(team_id)
|
|
3435
|
-
end
|
|
3436
|
-
end
|
|
3437
|
-
|
|
3438
3371
|
# Teams allow you to manage access to a shared group of applications and other resources.
|
|
3439
3372
|
class Team
|
|
3440
3373
|
def initialize(client)
|
|
@@ -3632,36 +3565,6 @@ module PlatformAPI
|
|
|
3632
3565
|
end
|
|
3633
3566
|
end
|
|
3634
3567
|
|
|
3635
|
-
# Entities that have been whitelisted to be used by a Team. Deprecated in favor of [Allowed Add-on Service](#allowed-add-on-service) endpoints.
|
|
3636
|
-
class WhitelistedAddonService
|
|
3637
|
-
def initialize(client)
|
|
3638
|
-
@client = client
|
|
3639
|
-
end
|
|
3640
|
-
|
|
3641
|
-
# List all whitelisted Add-on Services for a Team - Deprecated in favor of [`GET /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-list-by-team) endpoint.
|
|
3642
|
-
#
|
|
3643
|
-
# @param team_name_or_team_id: unique name of team or unique identifier of team
|
|
3644
|
-
def list_by_team_deprecated(team_name_or_team_id)
|
|
3645
|
-
@client.whitelisted_addon_service.list_by_team_deprecated(team_name_or_team_id)
|
|
3646
|
-
end
|
|
3647
|
-
|
|
3648
|
-
# Whitelist an Add-on Service - Deprecated in favor of [`POST /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-create-by-team) endpoint.
|
|
3649
|
-
#
|
|
3650
|
-
# @param team_name_or_team_id: unique name of team or unique identifier of team
|
|
3651
|
-
# @param body: the object to pass as the request payload
|
|
3652
|
-
def create_by_team_deprecated(team_name_or_team_id, body = {})
|
|
3653
|
-
@client.whitelisted_addon_service.create_by_team_deprecated(team_name_or_team_id, body)
|
|
3654
|
-
end
|
|
3655
|
-
|
|
3656
|
-
# Remove a whitelisted entity - Deprecated in favor of [`DELETE /teams/{team_name_or_id}/allowed-addon-services/{allowed_add_on_service_id_or_name}`](#allowed-add-on-service-delete-by-team) endpoint.
|
|
3657
|
-
#
|
|
3658
|
-
# @param team_name_or_team_id: unique name of team or unique identifier of team
|
|
3659
|
-
# @param whitelisted_addon_service_id_or_addon_service_name: unique identifier for this whitelisting entity or unique name of this add-on-service
|
|
3660
|
-
def delete_by_team_deprecated(team_name_or_team_id, whitelisted_addon_service_id_or_addon_service_name)
|
|
3661
|
-
@client.whitelisted_addon_service.delete_by_team_deprecated(team_name_or_team_id, whitelisted_addon_service_id_or_addon_service_name)
|
|
3662
|
-
end
|
|
3663
|
-
end
|
|
3664
|
-
|
|
3665
3568
|
SCHEMA = Heroics::Schema.new(MultiJson.load(<<-'HEROICS_SCHEMA'))
|
|
3666
3569
|
{
|
|
3667
3570
|
"$schema": "http://interagent.github.io/interagent-hyper-schema",
|
|
@@ -4033,46 +3936,6 @@ module PlatformAPI
|
|
|
4033
3936
|
"type": [
|
|
4034
3937
|
"boolean"
|
|
4035
3938
|
]
|
|
4036
|
-
},
|
|
4037
|
-
"acknowledged_msa": {
|
|
4038
|
-
"deprecated": true,
|
|
4039
|
-
"description": "deprecated. whether account has acknowledged the MSA terms of service",
|
|
4040
|
-
"example": false,
|
|
4041
|
-
"readOnly": true,
|
|
4042
|
-
"type": [
|
|
4043
|
-
"boolean"
|
|
4044
|
-
]
|
|
4045
|
-
},
|
|
4046
|
-
"acknowledged_msa_at": {
|
|
4047
|
-
"deprecated": true,
|
|
4048
|
-
"description": "deprecated. when account has acknowledged the MSA terms of service",
|
|
4049
|
-
"example": "2012-01-01T12:00:00Z",
|
|
4050
|
-
"format": "date-time",
|
|
4051
|
-
"readOnly": true,
|
|
4052
|
-
"type": [
|
|
4053
|
-
"string",
|
|
4054
|
-
"null"
|
|
4055
|
-
]
|
|
4056
|
-
},
|
|
4057
|
-
"italian_customer_terms": {
|
|
4058
|
-
"deprecated": true,
|
|
4059
|
-
"description": "deprecated. whether account has acknowledged the Italian customer terms of service",
|
|
4060
|
-
"example": "affirmatively_accepted",
|
|
4061
|
-
"readOnly": true,
|
|
4062
|
-
"type": [
|
|
4063
|
-
"string",
|
|
4064
|
-
"null"
|
|
4065
|
-
]
|
|
4066
|
-
},
|
|
4067
|
-
"italian_partner_terms": {
|
|
4068
|
-
"deprecated": true,
|
|
4069
|
-
"description": "deprecated. whether account has acknowledged the Italian provider terms of service",
|
|
4070
|
-
"example": "affirmatively_accepted",
|
|
4071
|
-
"readOnly": true,
|
|
4072
|
-
"type": [
|
|
4073
|
-
"string",
|
|
4074
|
-
"null"
|
|
4075
|
-
]
|
|
4076
3939
|
}
|
|
4077
3940
|
},
|
|
4078
3941
|
"links": [
|
|
@@ -4113,7 +3976,7 @@ module PlatformAPI
|
|
|
4113
3976
|
"title": "Update"
|
|
4114
3977
|
},
|
|
4115
3978
|
{
|
|
4116
|
-
"description": "Delete account. Note that this action cannot be undone.",
|
|
3979
|
+
"description": "Delete account. Note that this action cannot be undone. Note: This endpoint requires the HTTP_HEROKU_PASSWORD or HTTP_HEROKU_PASSWORD_BASE64 header be set correctly for the user account.",
|
|
4117
3980
|
"href": "/account",
|
|
4118
3981
|
"method": "DELETE",
|
|
4119
3982
|
"rel": "destroy",
|
|
@@ -4159,7 +4022,7 @@ module PlatformAPI
|
|
|
4159
4022
|
"title": "Update By User"
|
|
4160
4023
|
},
|
|
4161
4024
|
{
|
|
4162
|
-
"description": "Delete account. Note that this action cannot be undone.",
|
|
4025
|
+
"description": "Delete account. Note that this action cannot be undone. Note: This endpoint requires the HTTP_HEROKU_PASSWORD or HTTP_HEROKU_PASSWORD_BASE64 header be set correctly for the user account.",
|
|
4163
4026
|
"href": "/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}",
|
|
4164
4027
|
"method": "DELETE",
|
|
4165
4028
|
"rel": "destroy",
|
|
@@ -4190,10 +4053,14 @@ module PlatformAPI
|
|
|
4190
4053
|
},
|
|
4191
4054
|
"identity_provider": {
|
|
4192
4055
|
"description": "Identity Provider details for federated users.",
|
|
4056
|
+
"strictProperties": true,
|
|
4193
4057
|
"properties": {
|
|
4194
4058
|
"id": {
|
|
4195
4059
|
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
4196
4060
|
},
|
|
4061
|
+
"name": {
|
|
4062
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
4063
|
+
},
|
|
4197
4064
|
"team": {
|
|
4198
4065
|
"type": [
|
|
4199
4066
|
"object"
|
|
@@ -4215,46 +4082,7 @@ module PlatformAPI
|
|
|
4215
4082
|
}
|
|
4216
4083
|
},
|
|
4217
4084
|
"owner": {
|
|
4218
|
-
"
|
|
4219
|
-
"properties": {
|
|
4220
|
-
"id": {
|
|
4221
|
-
"description": "unique identifier of the owner",
|
|
4222
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
4223
|
-
"format": "uuid",
|
|
4224
|
-
"readOnly": true,
|
|
4225
|
-
"type": [
|
|
4226
|
-
"string"
|
|
4227
|
-
]
|
|
4228
|
-
},
|
|
4229
|
-
"name": {
|
|
4230
|
-
"description": "name of the owner",
|
|
4231
|
-
"example": "acme",
|
|
4232
|
-
"readOnly": true,
|
|
4233
|
-
"type": [
|
|
4234
|
-
"string"
|
|
4235
|
-
]
|
|
4236
|
-
},
|
|
4237
|
-
"type": {
|
|
4238
|
-
"description": "type of the owner",
|
|
4239
|
-
"enum": [
|
|
4240
|
-
"team",
|
|
4241
|
-
"enterprise-account"
|
|
4242
|
-
],
|
|
4243
|
-
"example": "team",
|
|
4244
|
-
"readOnly": true,
|
|
4245
|
-
"type": [
|
|
4246
|
-
"string"
|
|
4247
|
-
]
|
|
4248
|
-
}
|
|
4249
|
-
},
|
|
4250
|
-
"readOnly": false,
|
|
4251
|
-
"required": [
|
|
4252
|
-
"id",
|
|
4253
|
-
"type"
|
|
4254
|
-
],
|
|
4255
|
-
"type": [
|
|
4256
|
-
"object"
|
|
4257
|
-
]
|
|
4085
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
4258
4086
|
}
|
|
4259
4087
|
},
|
|
4260
4088
|
"type": [
|
|
@@ -4286,18 +4114,6 @@ module PlatformAPI
|
|
|
4286
4114
|
"verified": {
|
|
4287
4115
|
"$ref": "#/definitions/account/definitions/verified"
|
|
4288
4116
|
},
|
|
4289
|
-
"acknowledged_msa": {
|
|
4290
|
-
"$ref": "#/definitions/account/definitions/acknowledged_msa"
|
|
4291
|
-
},
|
|
4292
|
-
"acknowledged_msa_at": {
|
|
4293
|
-
"$ref": "#/definitions/account/definitions/acknowledged_msa_at"
|
|
4294
|
-
},
|
|
4295
|
-
"italian_customer_terms": {
|
|
4296
|
-
"$ref": "#/definitions/account/definitions/italian_customer_terms"
|
|
4297
|
-
},
|
|
4298
|
-
"italian_partner_terms": {
|
|
4299
|
-
"$ref": "#/definitions/account/definitions/italian_partner_terms"
|
|
4300
|
-
},
|
|
4301
4117
|
"country_of_residence": {
|
|
4302
4118
|
"$ref": "#/definitions/account/definitions/country_of_residence"
|
|
4303
4119
|
},
|
|
@@ -4351,7 +4167,7 @@ module PlatformAPI
|
|
|
4351
4167
|
"description": "Mark an add-on as provisioned for use.",
|
|
4352
4168
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/provision",
|
|
4353
4169
|
"method": "POST",
|
|
4354
|
-
"rel": "
|
|
4170
|
+
"rel": "update",
|
|
4355
4171
|
"targetSchema": {
|
|
4356
4172
|
"$ref": "#/definitions/add-on"
|
|
4357
4173
|
},
|
|
@@ -4361,7 +4177,7 @@ module PlatformAPI
|
|
|
4361
4177
|
"description": "Mark an add-on as deprovisioned.",
|
|
4362
4178
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/deprovision",
|
|
4363
4179
|
"method": "POST",
|
|
4364
|
-
"rel": "
|
|
4180
|
+
"rel": "update",
|
|
4365
4181
|
"targetSchema": {
|
|
4366
4182
|
"$ref": "#/definitions/add-on"
|
|
4367
4183
|
},
|
|
@@ -5374,8 +5190,24 @@ module PlatformAPI
|
|
|
5374
5190
|
"description": "Add-ons represent add-ons that have been provisioned and attached to one or more apps.",
|
|
5375
5191
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
5376
5192
|
"stability": "production",
|
|
5377
|
-
"strictProperties": true,
|
|
5378
5193
|
"title": "Heroku Platform API - Add-on",
|
|
5194
|
+
"additionalProperties": false,
|
|
5195
|
+
"required": [
|
|
5196
|
+
"actions",
|
|
5197
|
+
"addon_service",
|
|
5198
|
+
"billing_entity",
|
|
5199
|
+
"app",
|
|
5200
|
+
"billed_price",
|
|
5201
|
+
"config_vars",
|
|
5202
|
+
"created_at",
|
|
5203
|
+
"id",
|
|
5204
|
+
"name",
|
|
5205
|
+
"plan",
|
|
5206
|
+
"provider_id",
|
|
5207
|
+
"state",
|
|
5208
|
+
"updated_at",
|
|
5209
|
+
"web_url"
|
|
5210
|
+
],
|
|
5379
5211
|
"type": [
|
|
5380
5212
|
"object"
|
|
5381
5213
|
],
|
|
@@ -5540,14 +5372,65 @@ module PlatformAPI
|
|
|
5540
5372
|
"null",
|
|
5541
5373
|
"string"
|
|
5542
5374
|
]
|
|
5543
|
-
}
|
|
5544
|
-
|
|
5545
|
-
|
|
5546
|
-
|
|
5547
|
-
|
|
5548
|
-
|
|
5549
|
-
|
|
5550
|
-
|
|
5375
|
+
},
|
|
5376
|
+
"addon_service": {
|
|
5377
|
+
"description": "identity of add-on service",
|
|
5378
|
+
"anyOf": [
|
|
5379
|
+
{
|
|
5380
|
+
"properties": {
|
|
5381
|
+
"id": {
|
|
5382
|
+
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
5383
|
+
},
|
|
5384
|
+
"name": {
|
|
5385
|
+
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
5386
|
+
}
|
|
5387
|
+
},
|
|
5388
|
+
"strictProperties": true,
|
|
5389
|
+
"type": [
|
|
5390
|
+
"object"
|
|
5391
|
+
]
|
|
5392
|
+
},
|
|
5393
|
+
{
|
|
5394
|
+
"$ref": "#/definitions/add-on-service"
|
|
5395
|
+
}
|
|
5396
|
+
]
|
|
5397
|
+
},
|
|
5398
|
+
"plan": {
|
|
5399
|
+
"description": "identity of add-on plan",
|
|
5400
|
+
"anyOf": [
|
|
5401
|
+
{
|
|
5402
|
+
"properties": {
|
|
5403
|
+
"id": {
|
|
5404
|
+
"$ref": "#/definitions/plan/definitions/id"
|
|
5405
|
+
},
|
|
5406
|
+
"name": {
|
|
5407
|
+
"$ref": "#/definitions/plan/definitions/name"
|
|
5408
|
+
}
|
|
5409
|
+
},
|
|
5410
|
+
"strictProperties": true,
|
|
5411
|
+
"type": [
|
|
5412
|
+
"object"
|
|
5413
|
+
]
|
|
5414
|
+
},
|
|
5415
|
+
{
|
|
5416
|
+
"$ref": "#/definitions/plan"
|
|
5417
|
+
}
|
|
5418
|
+
]
|
|
5419
|
+
},
|
|
5420
|
+
"provision_message": {
|
|
5421
|
+
"description": "A provision message",
|
|
5422
|
+
"readOnly": true,
|
|
5423
|
+
"type": [
|
|
5424
|
+
"string"
|
|
5425
|
+
]
|
|
5426
|
+
}
|
|
5427
|
+
},
|
|
5428
|
+
"links": [
|
|
5429
|
+
{
|
|
5430
|
+
"description": "List all existing add-ons.",
|
|
5431
|
+
"href": "/addons",
|
|
5432
|
+
"method": "GET",
|
|
5433
|
+
"rel": "instances",
|
|
5551
5434
|
"targetSchema": {
|
|
5552
5435
|
"items": {
|
|
5553
5436
|
"$ref": "#/definitions/add-on"
|
|
@@ -5670,6 +5553,9 @@ module PlatformAPI
|
|
|
5670
5553
|
"object"
|
|
5671
5554
|
]
|
|
5672
5555
|
},
|
|
5556
|
+
"targetSchema": {
|
|
5557
|
+
"$ref": "#/definitions/add-on"
|
|
5558
|
+
},
|
|
5673
5559
|
"title": "Update"
|
|
5674
5560
|
},
|
|
5675
5561
|
{
|
|
@@ -5742,19 +5628,7 @@ module PlatformAPI
|
|
|
5742
5628
|
"$ref": "#/definitions/add-on/definitions/actions"
|
|
5743
5629
|
},
|
|
5744
5630
|
"addon_service": {
|
|
5745
|
-
"
|
|
5746
|
-
"properties": {
|
|
5747
|
-
"id": {
|
|
5748
|
-
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
5749
|
-
},
|
|
5750
|
-
"name": {
|
|
5751
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
5752
|
-
}
|
|
5753
|
-
},
|
|
5754
|
-
"strictProperties": true,
|
|
5755
|
-
"type": [
|
|
5756
|
-
"object"
|
|
5757
|
-
]
|
|
5631
|
+
"$ref": "#/definitions/add-on/definitions/addon_service"
|
|
5758
5632
|
},
|
|
5759
5633
|
"billing_entity": {
|
|
5760
5634
|
"description": "billing entity associated with this add-on",
|
|
@@ -5841,23 +5715,14 @@ module PlatformAPI
|
|
|
5841
5715
|
"$ref": "#/definitions/add-on/definitions/name"
|
|
5842
5716
|
},
|
|
5843
5717
|
"plan": {
|
|
5844
|
-
"
|
|
5845
|
-
"properties": {
|
|
5846
|
-
"id": {
|
|
5847
|
-
"$ref": "#/definitions/plan/definitions/id"
|
|
5848
|
-
},
|
|
5849
|
-
"name": {
|
|
5850
|
-
"$ref": "#/definitions/plan/definitions/name"
|
|
5851
|
-
}
|
|
5852
|
-
},
|
|
5853
|
-
"strictProperties": true,
|
|
5854
|
-
"type": [
|
|
5855
|
-
"object"
|
|
5856
|
-
]
|
|
5718
|
+
"$ref": "#/definitions/add-on/definitions/plan"
|
|
5857
5719
|
},
|
|
5858
5720
|
"provider_id": {
|
|
5859
5721
|
"$ref": "#/definitions/add-on/definitions/provider_id"
|
|
5860
5722
|
},
|
|
5723
|
+
"provision_message": {
|
|
5724
|
+
"$ref": "#/definitions/add-on/definitions/provision_message"
|
|
5725
|
+
},
|
|
5861
5726
|
"state": {
|
|
5862
5727
|
"$ref": "#/definitions/add-on/definitions/state"
|
|
5863
5728
|
},
|
|
@@ -6207,63 +6072,6 @@ module PlatformAPI
|
|
|
6207
6072
|
}
|
|
6208
6073
|
}
|
|
6209
6074
|
},
|
|
6210
|
-
"app-formation-set": {
|
|
6211
|
-
"description": "App formation set describes the combination of process types with their quantities and sizes as well as application process tier",
|
|
6212
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6213
|
-
"stability": "development",
|
|
6214
|
-
"strictProperties": true,
|
|
6215
|
-
"title": "Heroku Platform API - Application Formation Set",
|
|
6216
|
-
"type": [
|
|
6217
|
-
"object"
|
|
6218
|
-
],
|
|
6219
|
-
"properties": {
|
|
6220
|
-
"description": {
|
|
6221
|
-
"description": "a string representation of the formation set",
|
|
6222
|
-
"example": "web@2:Standard-2X worker@3:Performance-M",
|
|
6223
|
-
"readOnly": true,
|
|
6224
|
-
"type": [
|
|
6225
|
-
"string"
|
|
6226
|
-
]
|
|
6227
|
-
},
|
|
6228
|
-
"process_tier": {
|
|
6229
|
-
"description": "application process tier",
|
|
6230
|
-
"enum": [
|
|
6231
|
-
"production",
|
|
6232
|
-
"free",
|
|
6233
|
-
"hobby",
|
|
6234
|
-
"private"
|
|
6235
|
-
],
|
|
6236
|
-
"example": "production",
|
|
6237
|
-
"readOnly": true,
|
|
6238
|
-
"type": [
|
|
6239
|
-
"string"
|
|
6240
|
-
]
|
|
6241
|
-
},
|
|
6242
|
-
"app": {
|
|
6243
|
-
"description": "app being described by the formation-set",
|
|
6244
|
-
"properties": {
|
|
6245
|
-
"name": {
|
|
6246
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
6247
|
-
},
|
|
6248
|
-
"id": {
|
|
6249
|
-
"$ref": "#/definitions/app/definitions/id"
|
|
6250
|
-
}
|
|
6251
|
-
},
|
|
6252
|
-
"type": [
|
|
6253
|
-
"object"
|
|
6254
|
-
]
|
|
6255
|
-
},
|
|
6256
|
-
"updated_at": {
|
|
6257
|
-
"description": "last time fomation-set was updated",
|
|
6258
|
-
"example": "2012-01-01T12:00:00Z",
|
|
6259
|
-
"format": "date-time",
|
|
6260
|
-
"readOnly": true,
|
|
6261
|
-
"type": [
|
|
6262
|
-
"string"
|
|
6263
|
-
]
|
|
6264
|
-
}
|
|
6265
|
-
}
|
|
6266
|
-
},
|
|
6267
6075
|
"app-setup": {
|
|
6268
6076
|
"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.",
|
|
6269
6077
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
@@ -7591,9 +7399,10 @@ module PlatformAPI
|
|
|
7591
7399
|
"description": "web URL of app",
|
|
7592
7400
|
"example": "https://example.herokuapp.com/",
|
|
7593
7401
|
"format": "uri",
|
|
7594
|
-
"pattern": "^https?://[a-z][a-z0-9-]{3,
|
|
7402
|
+
"pattern": "^https?://[a-z][a-z0-9-]{3,43}\\.herokuapp\\.com/$",
|
|
7595
7403
|
"readOnly": true,
|
|
7596
7404
|
"type": [
|
|
7405
|
+
"null",
|
|
7597
7406
|
"string"
|
|
7598
7407
|
]
|
|
7599
7408
|
},
|
|
@@ -7623,6 +7432,15 @@ module PlatformAPI
|
|
|
7623
7432
|
},
|
|
7624
7433
|
"stack": {
|
|
7625
7434
|
"$ref": "#/definitions/stack/definitions/identity"
|
|
7435
|
+
},
|
|
7436
|
+
"feature_flags": {
|
|
7437
|
+
"description": "unique name of app feature",
|
|
7438
|
+
"type": [
|
|
7439
|
+
"array"
|
|
7440
|
+
],
|
|
7441
|
+
"items": {
|
|
7442
|
+
"$ref": "#/definitions/app-feature/definitions/name"
|
|
7443
|
+
}
|
|
7626
7444
|
}
|
|
7627
7445
|
},
|
|
7628
7446
|
"type": [
|
|
@@ -8189,7 +8007,7 @@ module PlatformAPI
|
|
|
8189
8007
|
},
|
|
8190
8008
|
"links": [
|
|
8191
8009
|
{
|
|
8192
|
-
"description": "List existing events. Returns all events for one
|
|
8010
|
+
"description": "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.",
|
|
8193
8011
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
|
|
8194
8012
|
"method": "GET",
|
|
8195
8013
|
"rel": "instances",
|
|
@@ -8237,7 +8055,15 @@ module PlatformAPI
|
|
|
8237
8055
|
"description": "A build represents the process of transforming a code tarball into a slug",
|
|
8238
8056
|
"title": "Heroku Build API - Build",
|
|
8239
8057
|
"stability": "production",
|
|
8240
|
-
"strictProperties":
|
|
8058
|
+
"strictProperties": false,
|
|
8059
|
+
"required": [
|
|
8060
|
+
"created_at",
|
|
8061
|
+
"id",
|
|
8062
|
+
"source_blob",
|
|
8063
|
+
"status",
|
|
8064
|
+
"updated_at",
|
|
8065
|
+
"user"
|
|
8066
|
+
],
|
|
8241
8067
|
"type": [
|
|
8242
8068
|
"object"
|
|
8243
8069
|
],
|
|
@@ -8360,6 +8186,15 @@ module PlatformAPI
|
|
|
8360
8186
|
"string",
|
|
8361
8187
|
"null"
|
|
8362
8188
|
]
|
|
8189
|
+
},
|
|
8190
|
+
"version_description": {
|
|
8191
|
+
"description": "Version description of the gzipped tarball.",
|
|
8192
|
+
"example": "* Fake User: Change session key",
|
|
8193
|
+
"readOnly": true,
|
|
8194
|
+
"type": [
|
|
8195
|
+
"string",
|
|
8196
|
+
"null"
|
|
8197
|
+
]
|
|
8363
8198
|
}
|
|
8364
8199
|
},
|
|
8365
8200
|
"strictProperties": true,
|
|
@@ -8369,7 +8204,7 @@ module PlatformAPI
|
|
|
8369
8204
|
},
|
|
8370
8205
|
"stack": {
|
|
8371
8206
|
"description": "stack of build",
|
|
8372
|
-
"example": "heroku-
|
|
8207
|
+
"example": "heroku-22",
|
|
8373
8208
|
"readOnly": true,
|
|
8374
8209
|
"type": [
|
|
8375
8210
|
"string"
|
|
@@ -8460,6 +8295,16 @@ module PlatformAPI
|
|
|
8460
8295
|
"method": "DELETE",
|
|
8461
8296
|
"rel": "empty",
|
|
8462
8297
|
"title": "Delete cache"
|
|
8298
|
+
},
|
|
8299
|
+
{
|
|
8300
|
+
"description": "Cancel running build.",
|
|
8301
|
+
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}",
|
|
8302
|
+
"method": "DELETE",
|
|
8303
|
+
"rel": "self",
|
|
8304
|
+
"targetSchema": {
|
|
8305
|
+
"$ref": "#/definitions/build"
|
|
8306
|
+
},
|
|
8307
|
+
"title": "Cancel"
|
|
8463
8308
|
}
|
|
8464
8309
|
],
|
|
8465
8310
|
"properties": {
|
|
@@ -9204,30 +9049,6 @@ module PlatformAPI
|
|
|
9204
9049
|
}
|
|
9205
9050
|
},
|
|
9206
9051
|
"links": [
|
|
9207
|
-
{
|
|
9208
|
-
"deactivate_on": "2021-10-31",
|
|
9209
|
-
"description": "Create a new domain. Deprecated in favor of this same endpoint, but with a new required attribute of `sni_endpoint`. During the transitional phase sni_endpoint can be omitted entirely (current behavior), can be a valid id, or can be null which will skip auto-association.",
|
|
9210
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
|
|
9211
|
-
"method": "POST",
|
|
9212
|
-
"rel": "create",
|
|
9213
|
-
"schema": {
|
|
9214
|
-
"properties": {
|
|
9215
|
-
"hostname": {
|
|
9216
|
-
"$ref": "#/definitions/domain/definitions/hostname"
|
|
9217
|
-
}
|
|
9218
|
-
},
|
|
9219
|
-
"required": [
|
|
9220
|
-
"hostname"
|
|
9221
|
-
],
|
|
9222
|
-
"type": [
|
|
9223
|
-
"object"
|
|
9224
|
-
]
|
|
9225
|
-
},
|
|
9226
|
-
"targetSchema": {
|
|
9227
|
-
"$ref": "#/definitions/domain"
|
|
9228
|
-
},
|
|
9229
|
-
"title": "Create - Deprecated"
|
|
9230
|
-
},
|
|
9231
9052
|
{
|
|
9232
9053
|
"description": "Create a new domain.",
|
|
9233
9054
|
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
|
|
@@ -9428,7 +9249,7 @@ module PlatformAPI
|
|
|
9428
9249
|
},
|
|
9429
9250
|
"name": {
|
|
9430
9251
|
"description": "the name of this dyno-size",
|
|
9431
|
-
"example": "
|
|
9252
|
+
"example": "eco",
|
|
9432
9253
|
"readOnly": true,
|
|
9433
9254
|
"type": [
|
|
9434
9255
|
"string"
|
|
@@ -9461,13 +9282,22 @@ module PlatformAPI
|
|
|
9461
9282
|
}
|
|
9462
9283
|
},
|
|
9463
9284
|
"dyno_units": {
|
|
9464
|
-
"
|
|
9285
|
+
"deprecated": true,
|
|
9286
|
+
"description": "deprecated. See precise_dyno_units instead",
|
|
9465
9287
|
"example": 0,
|
|
9466
9288
|
"readOnly": true,
|
|
9467
9289
|
"type": [
|
|
9468
9290
|
"integer"
|
|
9469
9291
|
]
|
|
9470
9292
|
},
|
|
9293
|
+
"precise_dyno_units": {
|
|
9294
|
+
"description": "unit of consumption for Heroku Enterprise customers to 2 decimal places",
|
|
9295
|
+
"example": 0.28,
|
|
9296
|
+
"readOnly": true,
|
|
9297
|
+
"type": [
|
|
9298
|
+
"number"
|
|
9299
|
+
]
|
|
9300
|
+
},
|
|
9471
9301
|
"private_space_only": {
|
|
9472
9302
|
"description": "whether this dyno can only be provisioned in a private space",
|
|
9473
9303
|
"example": false,
|
|
@@ -9517,6 +9347,9 @@ module PlatformAPI
|
|
|
9517
9347
|
"dyno_units": {
|
|
9518
9348
|
"$ref": "#/definitions/dyno-size/definitions/dyno_units"
|
|
9519
9349
|
},
|
|
9350
|
+
"precise_dyno_units": {
|
|
9351
|
+
"$ref": "#/definitions/dyno-size/definitions/precise_dyno_units"
|
|
9352
|
+
},
|
|
9520
9353
|
"id": {
|
|
9521
9354
|
"$ref": "#/definitions/dyno-size/definitions/id"
|
|
9522
9355
|
},
|
|
@@ -9839,74 +9672,272 @@ module PlatformAPI
|
|
|
9839
9672
|
}
|
|
9840
9673
|
}
|
|
9841
9674
|
},
|
|
9842
|
-
"enterprise-account-
|
|
9675
|
+
"enterprise-account-daily-usage": {
|
|
9843
9676
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
9844
|
-
"description": "
|
|
9677
|
+
"description": "Usage for an enterprise account at a daily resolution.",
|
|
9845
9678
|
"stability": "development",
|
|
9846
9679
|
"strictProperties": true,
|
|
9847
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
9680
|
+
"title": "Heroku Platform API - Enterprise Account Daily Usage",
|
|
9848
9681
|
"type": [
|
|
9849
9682
|
"object"
|
|
9850
9683
|
],
|
|
9851
9684
|
"definitions": {
|
|
9852
|
-
"
|
|
9853
|
-
"description": "
|
|
9854
|
-
"example":
|
|
9855
|
-
"format": "uuid",
|
|
9685
|
+
"addons": {
|
|
9686
|
+
"description": "total add-on credits used",
|
|
9687
|
+
"example": 250.0,
|
|
9856
9688
|
"readOnly": true,
|
|
9857
9689
|
"type": [
|
|
9858
|
-
"
|
|
9690
|
+
"number"
|
|
9859
9691
|
]
|
|
9860
9692
|
},
|
|
9861
|
-
"
|
|
9862
|
-
"
|
|
9863
|
-
|
|
9864
|
-
|
|
9865
|
-
|
|
9693
|
+
"data": {
|
|
9694
|
+
"description": "total add-on credits used for first party add-ons",
|
|
9695
|
+
"example": 34.89,
|
|
9696
|
+
"readOnly": true,
|
|
9697
|
+
"type": [
|
|
9698
|
+
"number"
|
|
9866
9699
|
]
|
|
9867
9700
|
},
|
|
9868
|
-
"
|
|
9869
|
-
"description": "
|
|
9870
|
-
"
|
|
9871
|
-
|
|
9872
|
-
"create",
|
|
9873
|
-
"manage",
|
|
9874
|
-
"billing"
|
|
9875
|
-
],
|
|
9876
|
-
"example": "view",
|
|
9701
|
+
"date": {
|
|
9702
|
+
"description": "date of the usage",
|
|
9703
|
+
"example": "2019-01-01",
|
|
9704
|
+
"format": "date",
|
|
9877
9705
|
"readOnly": true,
|
|
9878
9706
|
"type": [
|
|
9879
9707
|
"string"
|
|
9880
9708
|
]
|
|
9881
9709
|
},
|
|
9882
|
-
"
|
|
9883
|
-
"description": "
|
|
9884
|
-
"example":
|
|
9885
|
-
"view"
|
|
9886
|
-
],
|
|
9710
|
+
"dynos": {
|
|
9711
|
+
"description": "dynos used",
|
|
9712
|
+
"example": 1.548,
|
|
9887
9713
|
"readOnly": true,
|
|
9888
9714
|
"type": [
|
|
9889
|
-
"
|
|
9890
|
-
]
|
|
9891
|
-
"items": {
|
|
9892
|
-
"$ref": "#/definitions/enterprise-account-member/definitions/permission"
|
|
9893
|
-
}
|
|
9715
|
+
"number"
|
|
9716
|
+
]
|
|
9894
9717
|
},
|
|
9895
|
-
"
|
|
9896
|
-
"description": "enterprise account
|
|
9718
|
+
"id": {
|
|
9719
|
+
"description": "enterprise account identifier",
|
|
9720
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
9721
|
+
"format": "uuid",
|
|
9722
|
+
"readOnly": true,
|
|
9897
9723
|
"type": [
|
|
9898
|
-
"
|
|
9899
|
-
]
|
|
9900
|
-
|
|
9901
|
-
|
|
9902
|
-
|
|
9903
|
-
|
|
9904
|
-
|
|
9905
|
-
|
|
9906
|
-
|
|
9907
|
-
|
|
9908
|
-
|
|
9909
|
-
|
|
9724
|
+
"string"
|
|
9725
|
+
]
|
|
9726
|
+
},
|
|
9727
|
+
"name": {
|
|
9728
|
+
"description": "name of the enterprise account",
|
|
9729
|
+
"example": "example-co",
|
|
9730
|
+
"readOnly": true,
|
|
9731
|
+
"type": [
|
|
9732
|
+
"string"
|
|
9733
|
+
]
|
|
9734
|
+
},
|
|
9735
|
+
"partner": {
|
|
9736
|
+
"description": "total add-on credits used for third party add-ons",
|
|
9737
|
+
"example": 12.34,
|
|
9738
|
+
"readOnly": true,
|
|
9739
|
+
"type": [
|
|
9740
|
+
"number"
|
|
9741
|
+
]
|
|
9742
|
+
},
|
|
9743
|
+
"space": {
|
|
9744
|
+
"description": "space credits used",
|
|
9745
|
+
"example": 1.548,
|
|
9746
|
+
"readOnly": true,
|
|
9747
|
+
"type": [
|
|
9748
|
+
"number"
|
|
9749
|
+
]
|
|
9750
|
+
},
|
|
9751
|
+
"start_date": {
|
|
9752
|
+
"description": "range start date",
|
|
9753
|
+
"example": "2019-01-25",
|
|
9754
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
9755
|
+
"readOnly": true,
|
|
9756
|
+
"type": [
|
|
9757
|
+
"string"
|
|
9758
|
+
]
|
|
9759
|
+
},
|
|
9760
|
+
"end_date": {
|
|
9761
|
+
"description": "range end date",
|
|
9762
|
+
"example": "2019-02-25",
|
|
9763
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
9764
|
+
"readOnly": true,
|
|
9765
|
+
"type": [
|
|
9766
|
+
"string"
|
|
9767
|
+
]
|
|
9768
|
+
}
|
|
9769
|
+
},
|
|
9770
|
+
"links": [
|
|
9771
|
+
{
|
|
9772
|
+
"description": "Retrieves usage for an enterprise account for a range of days. Start and end dates can be specified as query parameters using the date format YYYY-MM-DD. The enterprise account identifier can be found from the [enterprise account list](https://devcenter.heroku.com/articles/platform-api-reference#enterprise-account-list).\n",
|
|
9773
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/daily",
|
|
9774
|
+
"method": "GET",
|
|
9775
|
+
"rel": "instances",
|
|
9776
|
+
"title": "Info",
|
|
9777
|
+
"schema": {
|
|
9778
|
+
"properties": {
|
|
9779
|
+
"start": {
|
|
9780
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/start_date"
|
|
9781
|
+
},
|
|
9782
|
+
"end": {
|
|
9783
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/end_date"
|
|
9784
|
+
}
|
|
9785
|
+
},
|
|
9786
|
+
"required": [
|
|
9787
|
+
"start"
|
|
9788
|
+
],
|
|
9789
|
+
"type": [
|
|
9790
|
+
"object"
|
|
9791
|
+
]
|
|
9792
|
+
},
|
|
9793
|
+
"targetSchema": {
|
|
9794
|
+
"items": {
|
|
9795
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
|
9796
|
+
},
|
|
9797
|
+
"type": [
|
|
9798
|
+
"array"
|
|
9799
|
+
]
|
|
9800
|
+
}
|
|
9801
|
+
}
|
|
9802
|
+
],
|
|
9803
|
+
"properties": {
|
|
9804
|
+
"addons": {
|
|
9805
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/addons"
|
|
9806
|
+
},
|
|
9807
|
+
"teams": {
|
|
9808
|
+
"description": "usage by team",
|
|
9809
|
+
"type": [
|
|
9810
|
+
"array"
|
|
9811
|
+
],
|
|
9812
|
+
"items": {
|
|
9813
|
+
"type": [
|
|
9814
|
+
"object"
|
|
9815
|
+
],
|
|
9816
|
+
"properties": {
|
|
9817
|
+
"addons": {
|
|
9818
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
9819
|
+
},
|
|
9820
|
+
"apps": {
|
|
9821
|
+
"description": "app usage in the team",
|
|
9822
|
+
"type": [
|
|
9823
|
+
"array"
|
|
9824
|
+
],
|
|
9825
|
+
"items": {
|
|
9826
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
|
9827
|
+
}
|
|
9828
|
+
},
|
|
9829
|
+
"data": {
|
|
9830
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
9831
|
+
},
|
|
9832
|
+
"dynos": {
|
|
9833
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
9834
|
+
},
|
|
9835
|
+
"id": {
|
|
9836
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
|
9837
|
+
},
|
|
9838
|
+
"name": {
|
|
9839
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
|
9840
|
+
},
|
|
9841
|
+
"partner": {
|
|
9842
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
9843
|
+
},
|
|
9844
|
+
"space": {
|
|
9845
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
|
9846
|
+
}
|
|
9847
|
+
}
|
|
9848
|
+
}
|
|
9849
|
+
},
|
|
9850
|
+
"data": {
|
|
9851
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/data"
|
|
9852
|
+
},
|
|
9853
|
+
"date": {
|
|
9854
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/date"
|
|
9855
|
+
},
|
|
9856
|
+
"dynos": {
|
|
9857
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/dynos"
|
|
9858
|
+
},
|
|
9859
|
+
"id": {
|
|
9860
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/id"
|
|
9861
|
+
},
|
|
9862
|
+
"name": {
|
|
9863
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/name"
|
|
9864
|
+
},
|
|
9865
|
+
"partner": {
|
|
9866
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/partner"
|
|
9867
|
+
},
|
|
9868
|
+
"space": {
|
|
9869
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/space"
|
|
9870
|
+
}
|
|
9871
|
+
}
|
|
9872
|
+
},
|
|
9873
|
+
"enterprise-account-member": {
|
|
9874
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
9875
|
+
"description": "Enterprise account members are users with access to an enterprise account.",
|
|
9876
|
+
"stability": "development",
|
|
9877
|
+
"strictProperties": true,
|
|
9878
|
+
"title": "Heroku Platform API - Enterprise Account Member",
|
|
9879
|
+
"type": [
|
|
9880
|
+
"object"
|
|
9881
|
+
],
|
|
9882
|
+
"definitions": {
|
|
9883
|
+
"id": {
|
|
9884
|
+
"description": "unique identifier of the member",
|
|
9885
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
9886
|
+
"format": "uuid",
|
|
9887
|
+
"readOnly": true,
|
|
9888
|
+
"type": [
|
|
9889
|
+
"string"
|
|
9890
|
+
]
|
|
9891
|
+
},
|
|
9892
|
+
"identity": {
|
|
9893
|
+
"anyOf": [
|
|
9894
|
+
{
|
|
9895
|
+
"$ref": "#/definitions/enterprise-account-member/definitions/id"
|
|
9896
|
+
}
|
|
9897
|
+
]
|
|
9898
|
+
},
|
|
9899
|
+
"permission": {
|
|
9900
|
+
"description": "permission in the enterprise account",
|
|
9901
|
+
"enum": [
|
|
9902
|
+
"view",
|
|
9903
|
+
"create",
|
|
9904
|
+
"manage",
|
|
9905
|
+
"billing"
|
|
9906
|
+
],
|
|
9907
|
+
"example": "view",
|
|
9908
|
+
"readOnly": true,
|
|
9909
|
+
"type": [
|
|
9910
|
+
"string"
|
|
9911
|
+
]
|
|
9912
|
+
},
|
|
9913
|
+
"permissions": {
|
|
9914
|
+
"description": "permissions for enterprise account",
|
|
9915
|
+
"example": [
|
|
9916
|
+
"view"
|
|
9917
|
+
],
|
|
9918
|
+
"readOnly": true,
|
|
9919
|
+
"type": [
|
|
9920
|
+
"array"
|
|
9921
|
+
],
|
|
9922
|
+
"items": {
|
|
9923
|
+
"$ref": "#/definitions/enterprise-account-member/definitions/permission"
|
|
9924
|
+
}
|
|
9925
|
+
},
|
|
9926
|
+
"expanded_permissions": {
|
|
9927
|
+
"description": "enterprise account permissions",
|
|
9928
|
+
"type": [
|
|
9929
|
+
"array"
|
|
9930
|
+
],
|
|
9931
|
+
"items": {
|
|
9932
|
+
"type": [
|
|
9933
|
+
"object"
|
|
9934
|
+
],
|
|
9935
|
+
"properties": {
|
|
9936
|
+
"description": {
|
|
9937
|
+
"type": [
|
|
9938
|
+
"string"
|
|
9939
|
+
],
|
|
9940
|
+
"example": "View enterprise account members and teams."
|
|
9910
9941
|
},
|
|
9911
9942
|
"name": {
|
|
9912
9943
|
"$ref": "#/definitions/enterprise-account-member/definitions/permission",
|
|
@@ -10092,12 +10123,12 @@ module PlatformAPI
|
|
|
10092
10123
|
}
|
|
10093
10124
|
}
|
|
10094
10125
|
},
|
|
10095
|
-
"enterprise-account-usage
|
|
10126
|
+
"enterprise-account-monthly-usage": {
|
|
10096
10127
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
10097
|
-
"description": "Usage for an enterprise account at a
|
|
10128
|
+
"description": "Usage for an enterprise account at a monthly resolution.",
|
|
10098
10129
|
"stability": "development",
|
|
10099
10130
|
"strictProperties": true,
|
|
10100
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
10131
|
+
"title": "Heroku Platform API - Enterprise Account Monthly Usage",
|
|
10101
10132
|
"type": [
|
|
10102
10133
|
"object"
|
|
10103
10134
|
],
|
|
@@ -10110,21 +10141,20 @@ module PlatformAPI
|
|
|
10110
10141
|
"number"
|
|
10111
10142
|
]
|
|
10112
10143
|
},
|
|
10113
|
-
"
|
|
10114
|
-
"description": "
|
|
10115
|
-
"example":
|
|
10144
|
+
"connect": {
|
|
10145
|
+
"description": "average connect rows synced",
|
|
10146
|
+
"example": 15000,
|
|
10116
10147
|
"readOnly": true,
|
|
10117
10148
|
"type": [
|
|
10118
10149
|
"number"
|
|
10119
10150
|
]
|
|
10120
10151
|
},
|
|
10121
|
-
"
|
|
10122
|
-
"description": "
|
|
10123
|
-
"example":
|
|
10124
|
-
"format": "date",
|
|
10152
|
+
"data": {
|
|
10153
|
+
"description": "total add-on credits used for first party add-ons",
|
|
10154
|
+
"example": 34.89,
|
|
10125
10155
|
"readOnly": true,
|
|
10126
10156
|
"type": [
|
|
10127
|
-
"
|
|
10157
|
+
"number"
|
|
10128
10158
|
]
|
|
10129
10159
|
},
|
|
10130
10160
|
"dynos": {
|
|
@@ -10135,6 +10165,15 @@ module PlatformAPI
|
|
|
10135
10165
|
"number"
|
|
10136
10166
|
]
|
|
10137
10167
|
},
|
|
10168
|
+
"month": {
|
|
10169
|
+
"description": "year and month of the usage",
|
|
10170
|
+
"example": "2019-01",
|
|
10171
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
10172
|
+
"readOnly": true,
|
|
10173
|
+
"type": [
|
|
10174
|
+
"string"
|
|
10175
|
+
]
|
|
10176
|
+
},
|
|
10138
10177
|
"id": {
|
|
10139
10178
|
"description": "enterprise account identifier",
|
|
10140
10179
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
@@ -10167,18 +10206,52 @@ module PlatformAPI
|
|
|
10167
10206
|
"type": [
|
|
10168
10207
|
"number"
|
|
10169
10208
|
]
|
|
10209
|
+
},
|
|
10210
|
+
"start_date": {
|
|
10211
|
+
"description": "range start date",
|
|
10212
|
+
"example": "2019-01",
|
|
10213
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
10214
|
+
"readOnly": true,
|
|
10215
|
+
"type": [
|
|
10216
|
+
"string"
|
|
10217
|
+
]
|
|
10218
|
+
},
|
|
10219
|
+
"end_date": {
|
|
10220
|
+
"description": "range end date",
|
|
10221
|
+
"example": "2019-02",
|
|
10222
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
10223
|
+
"readOnly": true,
|
|
10224
|
+
"type": [
|
|
10225
|
+
"string"
|
|
10226
|
+
]
|
|
10170
10227
|
}
|
|
10171
10228
|
},
|
|
10172
10229
|
"links": [
|
|
10173
10230
|
{
|
|
10174
|
-
"description": "Retrieves usage for an enterprise account for a range of
|
|
10175
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/
|
|
10231
|
+
"description": "Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format YYYY-MM. If no end date is specified, one month of usage is returned. The enterprise account identifier can be found from the [enterprise account list](https://devcenter.heroku.com/articles/platform-api-reference#enterprise-account-list).\n",
|
|
10232
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/monthly",
|
|
10176
10233
|
"method": "GET",
|
|
10177
10234
|
"rel": "instances",
|
|
10178
10235
|
"title": "Info",
|
|
10236
|
+
"schema": {
|
|
10237
|
+
"properties": {
|
|
10238
|
+
"start": {
|
|
10239
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/start_date"
|
|
10240
|
+
},
|
|
10241
|
+
"end": {
|
|
10242
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/end_date"
|
|
10243
|
+
}
|
|
10244
|
+
},
|
|
10245
|
+
"required": [
|
|
10246
|
+
"start"
|
|
10247
|
+
],
|
|
10248
|
+
"type": [
|
|
10249
|
+
"object"
|
|
10250
|
+
]
|
|
10251
|
+
},
|
|
10179
10252
|
"targetSchema": {
|
|
10180
10253
|
"items": {
|
|
10181
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10254
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
|
10182
10255
|
},
|
|
10183
10256
|
"type": [
|
|
10184
10257
|
"array"
|
|
@@ -10188,7 +10261,7 @@ module PlatformAPI
|
|
|
10188
10261
|
],
|
|
10189
10262
|
"properties": {
|
|
10190
10263
|
"addons": {
|
|
10191
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10264
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/addons"
|
|
10192
10265
|
},
|
|
10193
10266
|
"teams": {
|
|
10194
10267
|
"description": "usage by team",
|
|
@@ -10201,7 +10274,7 @@ module PlatformAPI
|
|
|
10201
10274
|
],
|
|
10202
10275
|
"properties": {
|
|
10203
10276
|
"addons": {
|
|
10204
|
-
"$ref": "#/definitions/team-usage
|
|
10277
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
10205
10278
|
},
|
|
10206
10279
|
"apps": {
|
|
10207
10280
|
"description": "app usage in the team",
|
|
@@ -10209,237 +10282,65 @@ module PlatformAPI
|
|
|
10209
10282
|
"array"
|
|
10210
10283
|
],
|
|
10211
10284
|
"items": {
|
|
10212
|
-
"$ref": "#/definitions/team-usage
|
|
10285
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
|
10213
10286
|
}
|
|
10214
10287
|
},
|
|
10288
|
+
"connect": {
|
|
10289
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
|
10290
|
+
},
|
|
10215
10291
|
"data": {
|
|
10216
|
-
"$ref": "#/definitions/team-usage
|
|
10292
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
10217
10293
|
},
|
|
10218
10294
|
"dynos": {
|
|
10219
|
-
"$ref": "#/definitions/team-usage
|
|
10295
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
10220
10296
|
},
|
|
10221
10297
|
"id": {
|
|
10222
|
-
"$ref": "#/definitions/team-usage
|
|
10298
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
|
10223
10299
|
},
|
|
10224
10300
|
"name": {
|
|
10225
|
-
"$ref": "#/definitions/team-usage
|
|
10301
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
|
10226
10302
|
},
|
|
10227
10303
|
"partner": {
|
|
10228
|
-
"$ref": "#/definitions/team-usage
|
|
10304
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
10229
10305
|
},
|
|
10230
10306
|
"space": {
|
|
10231
|
-
"$ref": "#/definitions/team-usage
|
|
10307
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
|
10232
10308
|
}
|
|
10233
10309
|
}
|
|
10234
10310
|
}
|
|
10235
10311
|
},
|
|
10236
|
-
"
|
|
10237
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10312
|
+
"connect": {
|
|
10313
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/connect"
|
|
10238
10314
|
},
|
|
10239
|
-
"
|
|
10240
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10315
|
+
"data": {
|
|
10316
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/data"
|
|
10241
10317
|
},
|
|
10242
10318
|
"dynos": {
|
|
10243
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10319
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/dynos"
|
|
10244
10320
|
},
|
|
10245
10321
|
"id": {
|
|
10246
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10322
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/id"
|
|
10323
|
+
},
|
|
10324
|
+
"month": {
|
|
10325
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/month"
|
|
10247
10326
|
},
|
|
10248
10327
|
"name": {
|
|
10249
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10328
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/name"
|
|
10250
10329
|
},
|
|
10251
10330
|
"partner": {
|
|
10252
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10331
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/partner"
|
|
10253
10332
|
},
|
|
10254
10333
|
"space": {
|
|
10255
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
10334
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/space"
|
|
10256
10335
|
}
|
|
10257
10336
|
}
|
|
10258
10337
|
},
|
|
10259
|
-
"enterprise-account
|
|
10338
|
+
"enterprise-account": {
|
|
10260
10339
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
10261
|
-
"description": "
|
|
10340
|
+
"description": "Enterprise accounts allow companies to manage their development teams and billing.",
|
|
10262
10341
|
"stability": "development",
|
|
10263
10342
|
"strictProperties": true,
|
|
10264
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
10265
|
-
"type": [
|
|
10266
|
-
"object"
|
|
10267
|
-
],
|
|
10268
|
-
"definitions": {
|
|
10269
|
-
"addons": {
|
|
10270
|
-
"description": "total add-on credits used",
|
|
10271
|
-
"example": 250.0,
|
|
10272
|
-
"readOnly": true,
|
|
10273
|
-
"type": [
|
|
10274
|
-
"number"
|
|
10275
|
-
]
|
|
10276
|
-
},
|
|
10277
|
-
"connect": {
|
|
10278
|
-
"description": "average connect rows synced",
|
|
10279
|
-
"example": 15000,
|
|
10280
|
-
"readOnly": true,
|
|
10281
|
-
"type": [
|
|
10282
|
-
"number"
|
|
10283
|
-
]
|
|
10284
|
-
},
|
|
10285
|
-
"data": {
|
|
10286
|
-
"description": "total add-on credits used for first party add-ons",
|
|
10287
|
-
"example": 34.89,
|
|
10288
|
-
"readOnly": true,
|
|
10289
|
-
"type": [
|
|
10290
|
-
"number"
|
|
10291
|
-
]
|
|
10292
|
-
},
|
|
10293
|
-
"dynos": {
|
|
10294
|
-
"description": "dynos used",
|
|
10295
|
-
"example": 1.548,
|
|
10296
|
-
"readOnly": true,
|
|
10297
|
-
"type": [
|
|
10298
|
-
"number"
|
|
10299
|
-
]
|
|
10300
|
-
},
|
|
10301
|
-
"month": {
|
|
10302
|
-
"description": "year and month of the usage",
|
|
10303
|
-
"example": "2019-01",
|
|
10304
|
-
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
10305
|
-
"readOnly": true,
|
|
10306
|
-
"type": [
|
|
10307
|
-
"string"
|
|
10308
|
-
]
|
|
10309
|
-
},
|
|
10310
|
-
"id": {
|
|
10311
|
-
"description": "enterprise account identifier",
|
|
10312
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
10313
|
-
"format": "uuid",
|
|
10314
|
-
"readOnly": true,
|
|
10315
|
-
"type": [
|
|
10316
|
-
"string"
|
|
10317
|
-
]
|
|
10318
|
-
},
|
|
10319
|
-
"name": {
|
|
10320
|
-
"description": "name of the enterprise account",
|
|
10321
|
-
"example": "example-co",
|
|
10322
|
-
"readOnly": true,
|
|
10323
|
-
"type": [
|
|
10324
|
-
"string"
|
|
10325
|
-
]
|
|
10326
|
-
},
|
|
10327
|
-
"partner": {
|
|
10328
|
-
"description": "total add-on credits used for third party add-ons",
|
|
10329
|
-
"example": 12.34,
|
|
10330
|
-
"readOnly": true,
|
|
10331
|
-
"type": [
|
|
10332
|
-
"number"
|
|
10333
|
-
]
|
|
10334
|
-
},
|
|
10335
|
-
"space": {
|
|
10336
|
-
"description": "space credits used",
|
|
10337
|
-
"example": 1.548,
|
|
10338
|
-
"readOnly": true,
|
|
10339
|
-
"type": [
|
|
10340
|
-
"number"
|
|
10341
|
-
]
|
|
10342
|
-
}
|
|
10343
|
-
},
|
|
10344
|
-
"links": [
|
|
10345
|
-
{
|
|
10346
|
-
"description": "Retrieves usage for an enterprise account for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/enterprise-accounts/example-account/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.",
|
|
10347
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/monthly",
|
|
10348
|
-
"method": "GET",
|
|
10349
|
-
"rel": "instances",
|
|
10350
|
-
"title": "Info",
|
|
10351
|
-
"targetSchema": {
|
|
10352
|
-
"items": {
|
|
10353
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly"
|
|
10354
|
-
},
|
|
10355
|
-
"type": [
|
|
10356
|
-
"array"
|
|
10357
|
-
]
|
|
10358
|
-
}
|
|
10359
|
-
}
|
|
10360
|
-
],
|
|
10361
|
-
"properties": {
|
|
10362
|
-
"addons": {
|
|
10363
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/addons"
|
|
10364
|
-
},
|
|
10365
|
-
"teams": {
|
|
10366
|
-
"description": "usage by team",
|
|
10367
|
-
"type": [
|
|
10368
|
-
"array"
|
|
10369
|
-
],
|
|
10370
|
-
"items": {
|
|
10371
|
-
"type": [
|
|
10372
|
-
"object"
|
|
10373
|
-
],
|
|
10374
|
-
"properties": {
|
|
10375
|
-
"addons": {
|
|
10376
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/addons"
|
|
10377
|
-
},
|
|
10378
|
-
"apps": {
|
|
10379
|
-
"description": "app usage in the team",
|
|
10380
|
-
"type": [
|
|
10381
|
-
"array"
|
|
10382
|
-
],
|
|
10383
|
-
"items": {
|
|
10384
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/app_usage_monthly"
|
|
10385
|
-
}
|
|
10386
|
-
},
|
|
10387
|
-
"connect": {
|
|
10388
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/connect"
|
|
10389
|
-
},
|
|
10390
|
-
"data": {
|
|
10391
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/data"
|
|
10392
|
-
},
|
|
10393
|
-
"dynos": {
|
|
10394
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/dynos"
|
|
10395
|
-
},
|
|
10396
|
-
"id": {
|
|
10397
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/id"
|
|
10398
|
-
},
|
|
10399
|
-
"name": {
|
|
10400
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/name"
|
|
10401
|
-
},
|
|
10402
|
-
"partner": {
|
|
10403
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/partner"
|
|
10404
|
-
},
|
|
10405
|
-
"space": {
|
|
10406
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/space"
|
|
10407
|
-
}
|
|
10408
|
-
}
|
|
10409
|
-
}
|
|
10410
|
-
},
|
|
10411
|
-
"connect": {
|
|
10412
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/connect"
|
|
10413
|
-
},
|
|
10414
|
-
"data": {
|
|
10415
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/data"
|
|
10416
|
-
},
|
|
10417
|
-
"dynos": {
|
|
10418
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/dynos"
|
|
10419
|
-
},
|
|
10420
|
-
"id": {
|
|
10421
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/id"
|
|
10422
|
-
},
|
|
10423
|
-
"month": {
|
|
10424
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/month"
|
|
10425
|
-
},
|
|
10426
|
-
"name": {
|
|
10427
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/name"
|
|
10428
|
-
},
|
|
10429
|
-
"partner": {
|
|
10430
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/partner"
|
|
10431
|
-
},
|
|
10432
|
-
"space": {
|
|
10433
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/space"
|
|
10434
|
-
}
|
|
10435
|
-
}
|
|
10436
|
-
},
|
|
10437
|
-
"enterprise-account": {
|
|
10438
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
10439
|
-
"description": "Enterprise accounts allow companies to manage their development teams and billing.",
|
|
10440
|
-
"stability": "development",
|
|
10441
|
-
"strictProperties": true,
|
|
10442
|
-
"title": "Heroku Platform API - Enterprise Account",
|
|
10343
|
+
"title": "Heroku Platform API - Enterprise Account",
|
|
10443
10344
|
"type": [
|
|
10444
10345
|
"object"
|
|
10445
10346
|
],
|
|
@@ -10469,6 +10370,25 @@ module PlatformAPI
|
|
|
10469
10370
|
}
|
|
10470
10371
|
]
|
|
10471
10372
|
},
|
|
10373
|
+
"identity_provider": {
|
|
10374
|
+
"description": "Identity Provider associated with the Enterprise Account",
|
|
10375
|
+
"strictProperties": true,
|
|
10376
|
+
"type": [
|
|
10377
|
+
"null",
|
|
10378
|
+
"object"
|
|
10379
|
+
],
|
|
10380
|
+
"properties": {
|
|
10381
|
+
"id": {
|
|
10382
|
+
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
10383
|
+
},
|
|
10384
|
+
"name": {
|
|
10385
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
10386
|
+
},
|
|
10387
|
+
"owner": {
|
|
10388
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
10389
|
+
}
|
|
10390
|
+
}
|
|
10391
|
+
},
|
|
10472
10392
|
"name": {
|
|
10473
10393
|
"description": "unique name of the enterprise account",
|
|
10474
10394
|
"example": "example",
|
|
@@ -10529,6 +10449,9 @@ module PlatformAPI
|
|
|
10529
10449
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
|
10530
10450
|
"method": "GET",
|
|
10531
10451
|
"rel": "self",
|
|
10452
|
+
"targetSchema": {
|
|
10453
|
+
"$ref": "#/definitions/enterprise-account"
|
|
10454
|
+
},
|
|
10532
10455
|
"title": "Info"
|
|
10533
10456
|
},
|
|
10534
10457
|
{
|
|
@@ -10571,27 +10494,7 @@ module PlatformAPI
|
|
|
10571
10494
|
"$ref": "#/definitions/enterprise-account/definitions/trial"
|
|
10572
10495
|
},
|
|
10573
10496
|
"identity_provider": {
|
|
10574
|
-
"
|
|
10575
|
-
"strictProperties": true,
|
|
10576
|
-
"type": [
|
|
10577
|
-
"null",
|
|
10578
|
-
"object"
|
|
10579
|
-
],
|
|
10580
|
-
"properties": {
|
|
10581
|
-
"id": {
|
|
10582
|
-
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
10583
|
-
},
|
|
10584
|
-
"name": {
|
|
10585
|
-
"description": "user-friendly unique identifier for this identity provider",
|
|
10586
|
-
"example": "acme-sso",
|
|
10587
|
-
"type": [
|
|
10588
|
-
"string"
|
|
10589
|
-
]
|
|
10590
|
-
},
|
|
10591
|
-
"owner": {
|
|
10592
|
-
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
10593
|
-
}
|
|
10594
|
-
}
|
|
10497
|
+
"$ref": "#/definitions/enterprise-account/definitions/identity_provider"
|
|
10595
10498
|
}
|
|
10596
10499
|
}
|
|
10597
10500
|
},
|
|
@@ -10888,7 +10791,7 @@ module PlatformAPI
|
|
|
10888
10791
|
}
|
|
10889
10792
|
},
|
|
10890
10793
|
"identity-provider": {
|
|
10891
|
-
"description": "Identity Providers represent the SAML configuration of an Team.",
|
|
10794
|
+
"description": "Identity Providers represent the SAML configuration of an Enterprise Account or Team.",
|
|
10892
10795
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
10893
10796
|
"stability": "production",
|
|
10894
10797
|
"strictProperties": true,
|
|
@@ -10931,6 +10834,13 @@ module PlatformAPI
|
|
|
10931
10834
|
"string"
|
|
10932
10835
|
]
|
|
10933
10836
|
},
|
|
10837
|
+
"name": {
|
|
10838
|
+
"description": "user-friendly unique identifier for this identity provider",
|
|
10839
|
+
"example": "acme-sso",
|
|
10840
|
+
"type": [
|
|
10841
|
+
"string"
|
|
10842
|
+
]
|
|
10843
|
+
},
|
|
10934
10844
|
"slo_target_url": {
|
|
10935
10845
|
"description": "single log out URL for this identity provider",
|
|
10936
10846
|
"example": "https://example.com/idp/logout",
|
|
@@ -11384,6 +11294,9 @@ module PlatformAPI
|
|
|
11384
11294
|
"href": "/account/invoice-address",
|
|
11385
11295
|
"method": "GET",
|
|
11386
11296
|
"rel": "self",
|
|
11297
|
+
"targetSchema": {
|
|
11298
|
+
"$ref": "#/definitions/invoice-address"
|
|
11299
|
+
},
|
|
11387
11300
|
"title": "info"
|
|
11388
11301
|
},
|
|
11389
11302
|
{
|
|
@@ -11422,6 +11335,9 @@ module PlatformAPI
|
|
|
11422
11335
|
"type": [
|
|
11423
11336
|
"object"
|
|
11424
11337
|
]
|
|
11338
|
+
},
|
|
11339
|
+
"targetSchema": {
|
|
11340
|
+
"$ref": "#/definitions/invoice-address"
|
|
11425
11341
|
}
|
|
11426
11342
|
}
|
|
11427
11343
|
],
|
|
@@ -11762,7 +11678,11 @@ module PlatformAPI
|
|
|
11762
11678
|
"description": "add-on that created the drain",
|
|
11763
11679
|
"example": {
|
|
11764
11680
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
11765
|
-
"name": "singing-swiftly-1242"
|
|
11681
|
+
"name": "singing-swiftly-1242",
|
|
11682
|
+
"app": {
|
|
11683
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
11684
|
+
"name": "example"
|
|
11685
|
+
}
|
|
11766
11686
|
},
|
|
11767
11687
|
"properties": {
|
|
11768
11688
|
"id": {
|
|
@@ -11770,8 +11690,44 @@ module PlatformAPI
|
|
|
11770
11690
|
},
|
|
11771
11691
|
"name": {
|
|
11772
11692
|
"$ref": "#/definitions/add-on/definitions/name"
|
|
11693
|
+
},
|
|
11694
|
+
"app": {
|
|
11695
|
+
"description": "billing application associated with this add-on",
|
|
11696
|
+
"type": [
|
|
11697
|
+
"object"
|
|
11698
|
+
],
|
|
11699
|
+
"properties": {
|
|
11700
|
+
"id": {
|
|
11701
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
11702
|
+
},
|
|
11703
|
+
"name": {
|
|
11704
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
11705
|
+
}
|
|
11706
|
+
},
|
|
11707
|
+
"strictProperties": true
|
|
11708
|
+
}
|
|
11709
|
+
},
|
|
11710
|
+
"readOnly": true,
|
|
11711
|
+
"type": [
|
|
11712
|
+
"object",
|
|
11713
|
+
"null"
|
|
11714
|
+
]
|
|
11715
|
+
},
|
|
11716
|
+
"app": {
|
|
11717
|
+
"description": "application that is attached to this drain",
|
|
11718
|
+
"example": {
|
|
11719
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
11720
|
+
"name": "example"
|
|
11721
|
+
},
|
|
11722
|
+
"properties": {
|
|
11723
|
+
"id": {
|
|
11724
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
11725
|
+
},
|
|
11726
|
+
"name": {
|
|
11727
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
11773
11728
|
}
|
|
11774
11729
|
},
|
|
11730
|
+
"strictProperties": true,
|
|
11775
11731
|
"readOnly": true,
|
|
11776
11732
|
"type": [
|
|
11777
11733
|
"object",
|
|
@@ -11944,6 +11900,9 @@ module PlatformAPI
|
|
|
11944
11900
|
"addon": {
|
|
11945
11901
|
"$ref": "#/definitions/log-drain/definitions/addon"
|
|
11946
11902
|
},
|
|
11903
|
+
"app": {
|
|
11904
|
+
"$ref": "#/definitions/log-drain/definitions/app"
|
|
11905
|
+
},
|
|
11947
11906
|
"created_at": {
|
|
11948
11907
|
"$ref": "#/definitions/log-drain/definitions/created_at"
|
|
11949
11908
|
},
|
|
@@ -13076,10 +13035,16 @@ module PlatformAPI
|
|
|
13076
13035
|
"$ref": "#/definitions/account/definitions/email"
|
|
13077
13036
|
}
|
|
13078
13037
|
},
|
|
13038
|
+
"required": [
|
|
13039
|
+
"email"
|
|
13040
|
+
],
|
|
13079
13041
|
"type": [
|
|
13080
13042
|
"object"
|
|
13081
13043
|
]
|
|
13082
13044
|
},
|
|
13045
|
+
"targetSchema": {
|
|
13046
|
+
"$ref": "#/definitions/password-reset"
|
|
13047
|
+
},
|
|
13083
13048
|
"title": "Reset Password"
|
|
13084
13049
|
},
|
|
13085
13050
|
{
|
|
@@ -13096,10 +13061,17 @@ module PlatformAPI
|
|
|
13096
13061
|
"$ref": "#/definitions/password-reset/definitions/password_confirmation"
|
|
13097
13062
|
}
|
|
13098
13063
|
},
|
|
13064
|
+
"required": [
|
|
13065
|
+
"password",
|
|
13066
|
+
"password_confirmation"
|
|
13067
|
+
],
|
|
13099
13068
|
"type": [
|
|
13100
13069
|
"object"
|
|
13101
13070
|
]
|
|
13102
13071
|
},
|
|
13072
|
+
"targetSchema": {
|
|
13073
|
+
"$ref": "#/definitions/password-reset"
|
|
13074
|
+
},
|
|
13103
13075
|
"title": "Complete Reset Password"
|
|
13104
13076
|
}
|
|
13105
13077
|
],
|
|
@@ -13329,14 +13301,20 @@ module PlatformAPI
|
|
|
13329
13301
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}/actions/accept",
|
|
13330
13302
|
"method": "POST",
|
|
13331
13303
|
"rel": "empty",
|
|
13332
|
-
"title": "Accept"
|
|
13304
|
+
"title": "Accept",
|
|
13305
|
+
"targetSchema": {
|
|
13306
|
+
"$ref": "#/definitions/peering"
|
|
13307
|
+
}
|
|
13333
13308
|
},
|
|
13334
13309
|
{
|
|
13335
13310
|
"description": "Destroy an active peering connection with a private space.",
|
|
13336
13311
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
|
|
13337
13312
|
"rel": "empty",
|
|
13338
13313
|
"method": "DELETE",
|
|
13339
|
-
"title": "Destroy"
|
|
13314
|
+
"title": "Destroy",
|
|
13315
|
+
"targetSchema": {
|
|
13316
|
+
"$ref": "#/definitions/peering"
|
|
13317
|
+
}
|
|
13340
13318
|
},
|
|
13341
13319
|
{
|
|
13342
13320
|
"description": "Fetch information for existing peering connection",
|
|
@@ -13474,7 +13452,7 @@ module PlatformAPI
|
|
|
13474
13452
|
"links": [
|
|
13475
13453
|
{
|
|
13476
13454
|
"description": "List latest builds for each app in a pipeline",
|
|
13477
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
13455
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-builds",
|
|
13478
13456
|
"method": "GET",
|
|
13479
13457
|
"rel": "instances",
|
|
13480
13458
|
"targetSchema": {
|
|
@@ -13824,7 +13802,7 @@ module PlatformAPI
|
|
|
13824
13802
|
"links": [
|
|
13825
13803
|
{
|
|
13826
13804
|
"description": "List latest slug releases for each app in a pipeline",
|
|
13827
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
13805
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-deployments",
|
|
13828
13806
|
"method": "GET",
|
|
13829
13807
|
"rel": "instances",
|
|
13830
13808
|
"targetSchema": {
|
|
@@ -14173,7 +14151,7 @@ module PlatformAPI
|
|
|
14173
14151
|
"links": [
|
|
14174
14152
|
{
|
|
14175
14153
|
"description": "List latest releases for each app in a pipeline",
|
|
14176
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
14154
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-releases",
|
|
14177
14155
|
"method": "GET",
|
|
14178
14156
|
"rel": "instances",
|
|
14179
14157
|
"targetSchema": {
|
|
@@ -14200,7 +14178,7 @@ module PlatformAPI
|
|
|
14200
14178
|
"links": [
|
|
14201
14179
|
{
|
|
14202
14180
|
"description": "The stack for a given pipeline, used for CI and Review Apps that have no stack defined in app.json.",
|
|
14203
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
14181
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/pipeline-stack",
|
|
14204
14182
|
"method": "GET",
|
|
14205
14183
|
"rel": "self",
|
|
14206
14184
|
"targetSchema": {
|
|
@@ -14510,11 +14488,11 @@ module PlatformAPI
|
|
|
14510
14488
|
"targetSchema": {
|
|
14511
14489
|
"items": {
|
|
14512
14490
|
"$ref": "#/definitions/pipeline"
|
|
14513
|
-
}
|
|
14491
|
+
},
|
|
14492
|
+
"type": [
|
|
14493
|
+
"array"
|
|
14494
|
+
]
|
|
14514
14495
|
},
|
|
14515
|
-
"type": [
|
|
14516
|
-
"array"
|
|
14517
|
-
],
|
|
14518
14496
|
"title": "List"
|
|
14519
14497
|
}
|
|
14520
14498
|
],
|
|
@@ -14962,12 +14940,14 @@ module PlatformAPI
|
|
|
14962
14940
|
"ap-southeast-1",
|
|
14963
14941
|
"ap-southeast-2",
|
|
14964
14942
|
"eu-central-1",
|
|
14943
|
+
"eu-west-2",
|
|
14965
14944
|
"ap-northeast-2",
|
|
14966
14945
|
"ap-northeast-1",
|
|
14967
14946
|
"us-east-1",
|
|
14968
14947
|
"sa-east-1",
|
|
14969
14948
|
"us-west-1",
|
|
14970
|
-
"us-west-2"
|
|
14949
|
+
"us-west-2",
|
|
14950
|
+
"ca-central-1"
|
|
14971
14951
|
]
|
|
14972
14952
|
}
|
|
14973
14953
|
},
|
|
@@ -16213,6 +16193,18 @@ module PlatformAPI
|
|
|
16213
16193
|
"object"
|
|
16214
16194
|
],
|
|
16215
16195
|
"definitions": {
|
|
16196
|
+
"ca_signed?": {
|
|
16197
|
+
"readOnly": true,
|
|
16198
|
+
"type": [
|
|
16199
|
+
"boolean"
|
|
16200
|
+
]
|
|
16201
|
+
},
|
|
16202
|
+
"cert_domains": {
|
|
16203
|
+
"readOnly": true,
|
|
16204
|
+
"type": [
|
|
16205
|
+
"array"
|
|
16206
|
+
]
|
|
16207
|
+
},
|
|
16216
16208
|
"certificate_chain": {
|
|
16217
16209
|
"description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
|
|
16218
16210
|
"example": "-----BEGIN CERTIFICATE----- ...",
|
|
@@ -16221,20 +16213,38 @@ module PlatformAPI
|
|
|
16221
16213
|
"string"
|
|
16222
16214
|
]
|
|
16223
16215
|
},
|
|
16224
|
-
"
|
|
16225
|
-
"description": "
|
|
16226
|
-
"example": "
|
|
16216
|
+
"created_at": {
|
|
16217
|
+
"description": "when endpoint was created",
|
|
16218
|
+
"example": "2012-01-01T12:00:00Z",
|
|
16219
|
+
"format": "date-time",
|
|
16220
|
+
"readOnly": true,
|
|
16221
|
+
"type": [
|
|
16222
|
+
"string"
|
|
16223
|
+
]
|
|
16224
|
+
},
|
|
16225
|
+
"domains": {
|
|
16226
|
+
"description": "domains associated with this SSL certificate",
|
|
16227
|
+
"type": [
|
|
16228
|
+
"array"
|
|
16229
|
+
],
|
|
16230
|
+
"readOnly": true,
|
|
16231
|
+
"items": {
|
|
16232
|
+
"$ref": "#/definitions/domain/definitions/id"
|
|
16233
|
+
}
|
|
16234
|
+
},
|
|
16235
|
+
"display_name": {
|
|
16236
|
+
"description": "unique name for SSL certificate",
|
|
16237
|
+
"example": "example",
|
|
16238
|
+
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
16227
16239
|
"readOnly": false,
|
|
16228
16240
|
"type": [
|
|
16229
16241
|
"string",
|
|
16230
16242
|
"null"
|
|
16231
16243
|
]
|
|
16232
16244
|
},
|
|
16233
|
-
"
|
|
16234
|
-
"description": "when endpoint was created",
|
|
16235
|
-
"example": "2012-01-01T12:00:00Z",
|
|
16236
|
-
"format": "date-time",
|
|
16245
|
+
"expires_at": {
|
|
16237
16246
|
"readOnly": true,
|
|
16247
|
+
"format": "date-time",
|
|
16238
16248
|
"type": [
|
|
16239
16249
|
"string"
|
|
16240
16250
|
]
|
|
@@ -16258,6 +16268,12 @@ module PlatformAPI
|
|
|
16258
16268
|
}
|
|
16259
16269
|
]
|
|
16260
16270
|
},
|
|
16271
|
+
"issuer": {
|
|
16272
|
+
"readOnly": true,
|
|
16273
|
+
"type": [
|
|
16274
|
+
"string"
|
|
16275
|
+
]
|
|
16276
|
+
},
|
|
16261
16277
|
"name": {
|
|
16262
16278
|
"description": "unique name for SNI endpoint",
|
|
16263
16279
|
"example": "example",
|
|
@@ -16275,33 +16291,32 @@ module PlatformAPI
|
|
|
16275
16291
|
"string"
|
|
16276
16292
|
]
|
|
16277
16293
|
},
|
|
16278
|
-
"
|
|
16279
|
-
"description": "when SNI endpoint was updated",
|
|
16280
|
-
"example": "2012-01-01T12:00:00Z",
|
|
16281
|
-
"format": "date-time",
|
|
16294
|
+
"self_signed?": {
|
|
16282
16295
|
"readOnly": true,
|
|
16283
16296
|
"type": [
|
|
16284
|
-
"
|
|
16297
|
+
"boolean"
|
|
16285
16298
|
]
|
|
16286
16299
|
},
|
|
16287
|
-
"
|
|
16288
|
-
"
|
|
16300
|
+
"starts_at": {
|
|
16301
|
+
"readOnly": true,
|
|
16302
|
+
"format": "date-time",
|
|
16289
16303
|
"type": [
|
|
16290
|
-
"
|
|
16291
|
-
]
|
|
16304
|
+
"string"
|
|
16305
|
+
]
|
|
16306
|
+
},
|
|
16307
|
+
"subject": {
|
|
16292
16308
|
"readOnly": true,
|
|
16293
|
-
"
|
|
16294
|
-
"
|
|
16295
|
-
|
|
16309
|
+
"type": [
|
|
16310
|
+
"string"
|
|
16311
|
+
]
|
|
16296
16312
|
},
|
|
16297
|
-
"
|
|
16298
|
-
"description": "
|
|
16299
|
-
"example": "
|
|
16300
|
-
"
|
|
16301
|
-
"readOnly":
|
|
16313
|
+
"updated_at": {
|
|
16314
|
+
"description": "when SNI endpoint was updated",
|
|
16315
|
+
"example": "2012-01-01T12:00:00Z",
|
|
16316
|
+
"format": "date-time",
|
|
16317
|
+
"readOnly": true,
|
|
16302
16318
|
"type": [
|
|
16303
|
-
"string"
|
|
16304
|
-
"null"
|
|
16319
|
+
"string"
|
|
16305
16320
|
]
|
|
16306
16321
|
}
|
|
16307
16322
|
},
|
|
@@ -16400,9 +16415,6 @@ module PlatformAPI
|
|
|
16400
16415
|
"certificate_chain": {
|
|
16401
16416
|
"$ref": "#/definitions/sni-endpoint/definitions/certificate_chain"
|
|
16402
16417
|
},
|
|
16403
|
-
"cname": {
|
|
16404
|
-
"$ref": "#/definitions/sni-endpoint/definitions/cname"
|
|
16405
|
-
},
|
|
16406
16418
|
"created_at": {
|
|
16407
16419
|
"$ref": "#/definitions/sni-endpoint/definitions/created_at"
|
|
16408
16420
|
},
|
|
@@ -16443,25 +16455,25 @@ module PlatformAPI
|
|
|
16443
16455
|
],
|
|
16444
16456
|
"properties": {
|
|
16445
16457
|
"ca_signed?": {
|
|
16446
|
-
"$ref": "#/definitions/
|
|
16458
|
+
"$ref": "#/definitions/sni-endpoint/definitions/ca_signed?"
|
|
16447
16459
|
},
|
|
16448
16460
|
"cert_domains": {
|
|
16449
|
-
"$ref": "#/definitions/
|
|
16461
|
+
"$ref": "#/definitions/sni-endpoint/definitions/cert_domains"
|
|
16450
16462
|
},
|
|
16451
16463
|
"expires_at": {
|
|
16452
|
-
"$ref": "#/definitions/
|
|
16464
|
+
"$ref": "#/definitions/sni-endpoint/definitions/expires_at"
|
|
16453
16465
|
},
|
|
16454
16466
|
"issuer": {
|
|
16455
|
-
"$ref": "#/definitions/
|
|
16467
|
+
"$ref": "#/definitions/sni-endpoint/definitions/issuer"
|
|
16456
16468
|
},
|
|
16457
16469
|
"self_signed?": {
|
|
16458
|
-
"$ref": "#/definitions/
|
|
16470
|
+
"$ref": "#/definitions/sni-endpoint/definitions/self_signed?"
|
|
16459
16471
|
},
|
|
16460
16472
|
"starts_at": {
|
|
16461
|
-
"$ref": "#/definitions/
|
|
16473
|
+
"$ref": "#/definitions/sni-endpoint/definitions/starts_at"
|
|
16462
16474
|
},
|
|
16463
16475
|
"subject": {
|
|
16464
|
-
"$ref": "#/definitions/
|
|
16476
|
+
"$ref": "#/definitions/sni-endpoint/definitions/subject"
|
|
16465
16477
|
},
|
|
16466
16478
|
"id": {
|
|
16467
16479
|
"description": "unique identifier of this SSL certificate",
|
|
@@ -16956,7 +16968,7 @@ module PlatformAPI
|
|
|
16956
16968
|
]
|
|
16957
16969
|
},
|
|
16958
16970
|
"space": {
|
|
16959
|
-
"description": "A space is an isolated, highly available, secure app execution
|
|
16971
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
|
16960
16972
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
16961
16973
|
"stability": "prototype",
|
|
16962
16974
|
"strictProperties": true,
|
|
@@ -17032,6 +17044,13 @@ module PlatformAPI
|
|
|
17032
17044
|
"string"
|
|
17033
17045
|
]
|
|
17034
17046
|
},
|
|
17047
|
+
"log_drain_url": {
|
|
17048
|
+
"description": "URL to which all apps will drain logs. Only settable during space creation and enables direct logging. Must use HTTPS.",
|
|
17049
|
+
"example": "https://example.com/logs",
|
|
17050
|
+
"type": [
|
|
17051
|
+
"string"
|
|
17052
|
+
]
|
|
17053
|
+
},
|
|
17035
17054
|
"cidr": {
|
|
17036
17055
|
"description": "The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16",
|
|
17037
17056
|
"example": "172.20.20.30/16",
|
|
@@ -17131,6 +17150,9 @@ module PlatformAPI
|
|
|
17131
17150
|
},
|
|
17132
17151
|
"data_cidr": {
|
|
17133
17152
|
"$ref": "#/definitions/space/definitions/data_cidr"
|
|
17153
|
+
},
|
|
17154
|
+
"log_drain_url": {
|
|
17155
|
+
"$ref": "#/definitions/space/definitions/log_drain_url"
|
|
17134
17156
|
}
|
|
17135
17157
|
},
|
|
17136
17158
|
"required": [
|
|
@@ -17214,52 +17236,18 @@ module PlatformAPI
|
|
|
17214
17236
|
}
|
|
17215
17237
|
}
|
|
17216
17238
|
},
|
|
17217
|
-
"
|
|
17218
|
-
"description": "
|
|
17239
|
+
"stack": {
|
|
17240
|
+
"description": "Stacks are the different application execution environments available in the Heroku platform.",
|
|
17219
17241
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
17220
|
-
"title": "Heroku Platform API - SSL Endpoint",
|
|
17221
17242
|
"stability": "production",
|
|
17222
17243
|
"strictProperties": true,
|
|
17244
|
+
"title": "Heroku Platform API - Stack",
|
|
17223
17245
|
"type": [
|
|
17224
17246
|
"object"
|
|
17225
17247
|
],
|
|
17226
17248
|
"definitions": {
|
|
17227
|
-
"acm": {
|
|
17228
|
-
"readOnly": true,
|
|
17229
|
-
"type": [
|
|
17230
|
-
"boolean"
|
|
17231
|
-
]
|
|
17232
|
-
},
|
|
17233
|
-
"ca_signed?": {
|
|
17234
|
-
"readOnly": true,
|
|
17235
|
-
"type": [
|
|
17236
|
-
"boolean"
|
|
17237
|
-
]
|
|
17238
|
-
},
|
|
17239
|
-
"cert_domains": {
|
|
17240
|
-
"readOnly": true,
|
|
17241
|
-
"type": [
|
|
17242
|
-
"array"
|
|
17243
|
-
]
|
|
17244
|
-
},
|
|
17245
|
-
"certificate_chain": {
|
|
17246
|
-
"description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
|
|
17247
|
-
"example": "-----BEGIN CERTIFICATE----- ...",
|
|
17248
|
-
"readOnly": false,
|
|
17249
|
-
"type": [
|
|
17250
|
-
"string"
|
|
17251
|
-
]
|
|
17252
|
-
},
|
|
17253
|
-
"cname": {
|
|
17254
|
-
"description": "canonical name record, the address to point a domain at",
|
|
17255
|
-
"example": "example.herokussl.com",
|
|
17256
|
-
"readOnly": false,
|
|
17257
|
-
"type": [
|
|
17258
|
-
"string"
|
|
17259
|
-
]
|
|
17260
|
-
},
|
|
17261
17249
|
"created_at": {
|
|
17262
|
-
"description": "when
|
|
17250
|
+
"description": "when stack was introduced",
|
|
17263
17251
|
"example": "2012-01-01T12:00:00Z",
|
|
17264
17252
|
"format": "date-time",
|
|
17265
17253
|
"readOnly": true,
|
|
@@ -17267,25 +17255,16 @@ module PlatformAPI
|
|
|
17267
17255
|
"string"
|
|
17268
17256
|
]
|
|
17269
17257
|
},
|
|
17270
|
-
"
|
|
17271
|
-
"description": "
|
|
17272
|
-
"example":
|
|
17273
|
-
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
17274
|
-
"readOnly": false,
|
|
17275
|
-
"type": [
|
|
17276
|
-
"string",
|
|
17277
|
-
"null"
|
|
17278
|
-
]
|
|
17279
|
-
},
|
|
17280
|
-
"expires_at": {
|
|
17258
|
+
"default": {
|
|
17259
|
+
"description": "indicates this stack is the default for new apps",
|
|
17260
|
+
"example": true,
|
|
17281
17261
|
"readOnly": true,
|
|
17282
|
-
"format": "date-time",
|
|
17283
17262
|
"type": [
|
|
17284
|
-
"
|
|
17263
|
+
"boolean"
|
|
17285
17264
|
]
|
|
17286
17265
|
},
|
|
17287
17266
|
"id": {
|
|
17288
|
-
"description": "unique identifier of
|
|
17267
|
+
"description": "unique identifier of stack",
|
|
17289
17268
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
17290
17269
|
"format": "uuid",
|
|
17291
17270
|
"readOnly": true,
|
|
@@ -17296,66 +17275,31 @@ module PlatformAPI
|
|
|
17296
17275
|
"identity": {
|
|
17297
17276
|
"anyOf": [
|
|
17298
17277
|
{
|
|
17299
|
-
"$ref": "#/definitions/
|
|
17278
|
+
"$ref": "#/definitions/stack/definitions/name"
|
|
17300
17279
|
},
|
|
17301
17280
|
{
|
|
17302
|
-
"$ref": "#/definitions/
|
|
17281
|
+
"$ref": "#/definitions/stack/definitions/id"
|
|
17303
17282
|
}
|
|
17304
17283
|
]
|
|
17305
17284
|
},
|
|
17306
|
-
"issuer": {
|
|
17307
|
-
"readOnly": true,
|
|
17308
|
-
"type": [
|
|
17309
|
-
"string"
|
|
17310
|
-
]
|
|
17311
|
-
},
|
|
17312
17285
|
"name": {
|
|
17313
|
-
"description": "unique name
|
|
17314
|
-
"example": "
|
|
17315
|
-
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
17316
|
-
"readOnly": true,
|
|
17317
|
-
"type": [
|
|
17318
|
-
"string"
|
|
17319
|
-
]
|
|
17320
|
-
},
|
|
17321
|
-
"preprocess": {
|
|
17322
|
-
"default": true,
|
|
17323
|
-
"description": "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
|
|
17324
|
-
"example": true,
|
|
17325
|
-
"readOnly": false,
|
|
17326
|
-
"type": [
|
|
17327
|
-
"boolean"
|
|
17328
|
-
]
|
|
17329
|
-
},
|
|
17330
|
-
"private_key": {
|
|
17331
|
-
"description": "contents of the private key (eg .key file)",
|
|
17332
|
-
"example": "-----BEGIN RSA PRIVATE KEY----- ...",
|
|
17333
|
-
"readOnly": false,
|
|
17334
|
-
"type": [
|
|
17335
|
-
"string"
|
|
17336
|
-
]
|
|
17337
|
-
},
|
|
17338
|
-
"self_signed?": {
|
|
17339
|
-
"readOnly": true,
|
|
17340
|
-
"type": [
|
|
17341
|
-
"boolean"
|
|
17342
|
-
]
|
|
17343
|
-
},
|
|
17344
|
-
"starts_at": {
|
|
17286
|
+
"description": "unique name of stack",
|
|
17287
|
+
"example": "heroku-18",
|
|
17345
17288
|
"readOnly": true,
|
|
17346
|
-
"format": "date-time",
|
|
17347
17289
|
"type": [
|
|
17348
17290
|
"string"
|
|
17349
17291
|
]
|
|
17350
17292
|
},
|
|
17351
|
-
"
|
|
17293
|
+
"state": {
|
|
17294
|
+
"description": "availability of this stack: beta, deprecated or public",
|
|
17295
|
+
"example": "public",
|
|
17352
17296
|
"readOnly": true,
|
|
17353
17297
|
"type": [
|
|
17354
17298
|
"string"
|
|
17355
17299
|
]
|
|
17356
17300
|
},
|
|
17357
17301
|
"updated_at": {
|
|
17358
|
-
"description": "when
|
|
17302
|
+
"description": "when stack was last modified",
|
|
17359
17303
|
"example": "2012-01-01T12:00:00Z",
|
|
17360
17304
|
"format": "date-time",
|
|
17361
17305
|
"readOnly": true,
|
|
@@ -17366,285 +17310,34 @@ module PlatformAPI
|
|
|
17366
17310
|
},
|
|
17367
17311
|
"links": [
|
|
17368
17312
|
{
|
|
17369
|
-
"description": "
|
|
17370
|
-
"href": "/
|
|
17371
|
-
"method": "POST",
|
|
17372
|
-
"rel": "create",
|
|
17373
|
-
"schema": {
|
|
17374
|
-
"properties": {
|
|
17375
|
-
"certificate_chain": {
|
|
17376
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
17377
|
-
},
|
|
17378
|
-
"preprocess": {
|
|
17379
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/preprocess"
|
|
17380
|
-
},
|
|
17381
|
-
"private_key": {
|
|
17382
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/private_key"
|
|
17383
|
-
}
|
|
17384
|
-
},
|
|
17385
|
-
"required": [
|
|
17386
|
-
"certificate_chain",
|
|
17387
|
-
"private_key"
|
|
17388
|
-
],
|
|
17389
|
-
"type": [
|
|
17390
|
-
"object"
|
|
17391
|
-
]
|
|
17392
|
-
},
|
|
17393
|
-
"targetSchema": {
|
|
17394
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
17395
|
-
},
|
|
17396
|
-
"title": "Create"
|
|
17397
|
-
},
|
|
17398
|
-
{
|
|
17399
|
-
"description": "Delete existing SSL endpoint.",
|
|
17400
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}",
|
|
17401
|
-
"method": "DELETE",
|
|
17402
|
-
"rel": "destroy",
|
|
17403
|
-
"targetSchema": {
|
|
17404
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
17405
|
-
},
|
|
17406
|
-
"title": "Delete"
|
|
17407
|
-
},
|
|
17408
|
-
{
|
|
17409
|
-
"description": "Info for existing SSL endpoint.",
|
|
17410
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}",
|
|
17313
|
+
"description": "Stack info.",
|
|
17314
|
+
"href": "/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
|
|
17411
17315
|
"method": "GET",
|
|
17412
17316
|
"rel": "self",
|
|
17413
17317
|
"targetSchema": {
|
|
17414
|
-
"$ref": "#/definitions/
|
|
17318
|
+
"$ref": "#/definitions/stack"
|
|
17415
17319
|
},
|
|
17416
17320
|
"title": "Info"
|
|
17417
17321
|
},
|
|
17418
17322
|
{
|
|
17419
|
-
"description": "List
|
|
17420
|
-
"href": "/
|
|
17323
|
+
"description": "List available stacks.",
|
|
17324
|
+
"href": "/stacks",
|
|
17421
17325
|
"method": "GET",
|
|
17422
17326
|
"rel": "instances",
|
|
17423
17327
|
"targetSchema": {
|
|
17424
17328
|
"items": {
|
|
17425
|
-
"$ref": "#/definitions/
|
|
17329
|
+
"$ref": "#/definitions/stack"
|
|
17426
17330
|
},
|
|
17427
17331
|
"type": [
|
|
17428
17332
|
"array"
|
|
17429
17333
|
]
|
|
17430
17334
|
},
|
|
17431
17335
|
"title": "List"
|
|
17432
|
-
}
|
|
17433
|
-
|
|
17434
|
-
|
|
17435
|
-
|
|
17436
|
-
"
|
|
17437
|
-
"rel": "update",
|
|
17438
|
-
"schema": {
|
|
17439
|
-
"properties": {
|
|
17440
|
-
"certificate_chain": {
|
|
17441
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
17442
|
-
},
|
|
17443
|
-
"preprocess": {
|
|
17444
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/preprocess"
|
|
17445
|
-
},
|
|
17446
|
-
"private_key": {
|
|
17447
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/private_key"
|
|
17448
|
-
}
|
|
17449
|
-
},
|
|
17450
|
-
"type": [
|
|
17451
|
-
"object"
|
|
17452
|
-
]
|
|
17453
|
-
},
|
|
17454
|
-
"targetSchema": {
|
|
17455
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
17456
|
-
},
|
|
17457
|
-
"title": "Update"
|
|
17458
|
-
}
|
|
17459
|
-
],
|
|
17460
|
-
"properties": {
|
|
17461
|
-
"app": {
|
|
17462
|
-
"description": "application associated with this ssl-endpoint",
|
|
17463
|
-
"type": [
|
|
17464
|
-
"object"
|
|
17465
|
-
],
|
|
17466
|
-
"properties": {
|
|
17467
|
-
"id": {
|
|
17468
|
-
"$ref": "#/definitions/app/definitions/id"
|
|
17469
|
-
},
|
|
17470
|
-
"name": {
|
|
17471
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
17472
|
-
}
|
|
17473
|
-
},
|
|
17474
|
-
"strictProperties": true
|
|
17475
|
-
},
|
|
17476
|
-
"certificate_chain": {
|
|
17477
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
17478
|
-
},
|
|
17479
|
-
"cname": {
|
|
17480
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/cname"
|
|
17481
|
-
},
|
|
17482
|
-
"created_at": {
|
|
17483
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/created_at"
|
|
17484
|
-
},
|
|
17485
|
-
"display_name": {
|
|
17486
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/display_name"
|
|
17487
|
-
},
|
|
17488
|
-
"domains": {
|
|
17489
|
-
"description": "domains associated with this endpoint",
|
|
17490
|
-
"type": [
|
|
17491
|
-
"array"
|
|
17492
|
-
],
|
|
17493
|
-
"items": {
|
|
17494
|
-
"$ref": "#/definitions/domain/definitions/id"
|
|
17495
|
-
}
|
|
17496
|
-
},
|
|
17497
|
-
"id": {
|
|
17498
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/id"
|
|
17499
|
-
},
|
|
17500
|
-
"name": {
|
|
17501
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/name"
|
|
17502
|
-
},
|
|
17503
|
-
"ssl_cert": {
|
|
17504
|
-
"description": "certificate provided by this endpoint",
|
|
17505
|
-
"type": [
|
|
17506
|
-
"object"
|
|
17507
|
-
],
|
|
17508
|
-
"properties": {
|
|
17509
|
-
"ca_signed?": {
|
|
17510
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/ca_signed?"
|
|
17511
|
-
},
|
|
17512
|
-
"cert_domains": {
|
|
17513
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/cert_domains"
|
|
17514
|
-
},
|
|
17515
|
-
"expires_at": {
|
|
17516
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/expires_at"
|
|
17517
|
-
},
|
|
17518
|
-
"issuer": {
|
|
17519
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/issuer"
|
|
17520
|
-
},
|
|
17521
|
-
"self_signed?": {
|
|
17522
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/self_signed?"
|
|
17523
|
-
},
|
|
17524
|
-
"starts_at": {
|
|
17525
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/starts_at"
|
|
17526
|
-
},
|
|
17527
|
-
"subject": {
|
|
17528
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/subject"
|
|
17529
|
-
},
|
|
17530
|
-
"id": {
|
|
17531
|
-
"description": "unique identifier of this SSL certificate",
|
|
17532
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
17533
|
-
"format": "uuid",
|
|
17534
|
-
"readOnly": true,
|
|
17535
|
-
"type": [
|
|
17536
|
-
"string"
|
|
17537
|
-
]
|
|
17538
|
-
}
|
|
17539
|
-
}
|
|
17540
|
-
},
|
|
17541
|
-
"updated_at": {
|
|
17542
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/updated_at"
|
|
17543
|
-
}
|
|
17544
|
-
}
|
|
17545
|
-
},
|
|
17546
|
-
"stack": {
|
|
17547
|
-
"description": "Stacks are the different application execution environments available in the Heroku platform.",
|
|
17548
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
17549
|
-
"stability": "production",
|
|
17550
|
-
"strictProperties": true,
|
|
17551
|
-
"title": "Heroku Platform API - Stack",
|
|
17552
|
-
"type": [
|
|
17553
|
-
"object"
|
|
17554
|
-
],
|
|
17555
|
-
"definitions": {
|
|
17556
|
-
"created_at": {
|
|
17557
|
-
"description": "when stack was introduced",
|
|
17558
|
-
"example": "2012-01-01T12:00:00Z",
|
|
17559
|
-
"format": "date-time",
|
|
17560
|
-
"readOnly": true,
|
|
17561
|
-
"type": [
|
|
17562
|
-
"string"
|
|
17563
|
-
]
|
|
17564
|
-
},
|
|
17565
|
-
"default": {
|
|
17566
|
-
"description": "indicates this stack is the default for new apps",
|
|
17567
|
-
"example": true,
|
|
17568
|
-
"readOnly": true,
|
|
17569
|
-
"type": [
|
|
17570
|
-
"boolean"
|
|
17571
|
-
]
|
|
17572
|
-
},
|
|
17573
|
-
"id": {
|
|
17574
|
-
"description": "unique identifier of stack",
|
|
17575
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
17576
|
-
"format": "uuid",
|
|
17577
|
-
"readOnly": true,
|
|
17578
|
-
"type": [
|
|
17579
|
-
"string"
|
|
17580
|
-
]
|
|
17581
|
-
},
|
|
17582
|
-
"identity": {
|
|
17583
|
-
"anyOf": [
|
|
17584
|
-
{
|
|
17585
|
-
"$ref": "#/definitions/stack/definitions/name"
|
|
17586
|
-
},
|
|
17587
|
-
{
|
|
17588
|
-
"$ref": "#/definitions/stack/definitions/id"
|
|
17589
|
-
}
|
|
17590
|
-
]
|
|
17591
|
-
},
|
|
17592
|
-
"name": {
|
|
17593
|
-
"description": "unique name of stack",
|
|
17594
|
-
"example": "heroku-18",
|
|
17595
|
-
"readOnly": true,
|
|
17596
|
-
"type": [
|
|
17597
|
-
"string"
|
|
17598
|
-
]
|
|
17599
|
-
},
|
|
17600
|
-
"state": {
|
|
17601
|
-
"description": "availability of this stack: beta, deprecated or public",
|
|
17602
|
-
"example": "public",
|
|
17603
|
-
"readOnly": true,
|
|
17604
|
-
"type": [
|
|
17605
|
-
"string"
|
|
17606
|
-
]
|
|
17607
|
-
},
|
|
17608
|
-
"updated_at": {
|
|
17609
|
-
"description": "when stack was last modified",
|
|
17610
|
-
"example": "2012-01-01T12:00:00Z",
|
|
17611
|
-
"format": "date-time",
|
|
17612
|
-
"readOnly": true,
|
|
17613
|
-
"type": [
|
|
17614
|
-
"string"
|
|
17615
|
-
]
|
|
17616
|
-
}
|
|
17617
|
-
},
|
|
17618
|
-
"links": [
|
|
17619
|
-
{
|
|
17620
|
-
"description": "Stack info.",
|
|
17621
|
-
"href": "/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
|
|
17622
|
-
"method": "GET",
|
|
17623
|
-
"rel": "self",
|
|
17624
|
-
"targetSchema": {
|
|
17625
|
-
"$ref": "#/definitions/stack"
|
|
17626
|
-
},
|
|
17627
|
-
"title": "Info"
|
|
17628
|
-
},
|
|
17629
|
-
{
|
|
17630
|
-
"description": "List available stacks.",
|
|
17631
|
-
"href": "/stacks",
|
|
17632
|
-
"method": "GET",
|
|
17633
|
-
"rel": "instances",
|
|
17634
|
-
"targetSchema": {
|
|
17635
|
-
"items": {
|
|
17636
|
-
"$ref": "#/definitions/stack"
|
|
17637
|
-
},
|
|
17638
|
-
"type": [
|
|
17639
|
-
"array"
|
|
17640
|
-
]
|
|
17641
|
-
},
|
|
17642
|
-
"title": "List"
|
|
17643
|
-
}
|
|
17644
|
-
],
|
|
17645
|
-
"properties": {
|
|
17646
|
-
"default": {
|
|
17647
|
-
"$ref": "#/definitions/stack/definitions/default"
|
|
17336
|
+
}
|
|
17337
|
+
],
|
|
17338
|
+
"properties": {
|
|
17339
|
+
"default": {
|
|
17340
|
+
"$ref": "#/definitions/stack/definitions/default"
|
|
17648
17341
|
},
|
|
17649
17342
|
"created_at": {
|
|
17650
17343
|
"$ref": "#/definitions/stack/definitions/created_at"
|
|
@@ -18010,6 +17703,9 @@ module PlatformAPI
|
|
|
18010
17703
|
"object"
|
|
18011
17704
|
]
|
|
18012
17705
|
},
|
|
17706
|
+
"targetSchema": {
|
|
17707
|
+
"$ref": "#/definitions/team-app"
|
|
17708
|
+
},
|
|
18013
17709
|
"title": "Create"
|
|
18014
17710
|
},
|
|
18015
17711
|
{
|
|
@@ -18017,6 +17713,9 @@ module PlatformAPI
|
|
|
18017
17713
|
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
18018
17714
|
"method": "GET",
|
|
18019
17715
|
"rel": "self",
|
|
17716
|
+
"targetSchema": {
|
|
17717
|
+
"$ref": "#/definitions/team-app"
|
|
17718
|
+
},
|
|
18020
17719
|
"title": "Info"
|
|
18021
17720
|
},
|
|
18022
17721
|
{
|
|
@@ -18233,51 +17932,74 @@ module PlatformAPI
|
|
|
18233
17932
|
}
|
|
18234
17933
|
}
|
|
18235
17934
|
},
|
|
18236
|
-
"team-
|
|
18237
|
-
"description": "A team feature represents a feature enabled on a team account.",
|
|
17935
|
+
"team-daily-usage": {
|
|
18238
17936
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
17937
|
+
"description": "Usage for an enterprise team at a daily resolution.",
|
|
18239
17938
|
"stability": "development",
|
|
18240
17939
|
"strictProperties": true,
|
|
18241
|
-
"title": "Heroku Platform API - Team
|
|
17940
|
+
"title": "Heroku Platform API - Team Daily Usage",
|
|
18242
17941
|
"type": [
|
|
18243
17942
|
"object"
|
|
18244
17943
|
],
|
|
18245
17944
|
"definitions": {
|
|
18246
|
-
"
|
|
18247
|
-
"description": "
|
|
18248
|
-
"example":
|
|
18249
|
-
"format": "date-time",
|
|
17945
|
+
"addons": {
|
|
17946
|
+
"description": "total add-on credits used",
|
|
17947
|
+
"example": 250.0,
|
|
18250
17948
|
"readOnly": true,
|
|
18251
17949
|
"type": [
|
|
18252
|
-
"
|
|
17950
|
+
"number"
|
|
18253
17951
|
]
|
|
18254
17952
|
},
|
|
18255
|
-
"
|
|
18256
|
-
"description": "
|
|
18257
|
-
"
|
|
17953
|
+
"app_usage_daily": {
|
|
17954
|
+
"description": "Usage for an app at a daily resolution.",
|
|
17955
|
+
"type": [
|
|
17956
|
+
"object"
|
|
17957
|
+
],
|
|
17958
|
+
"properties": {
|
|
17959
|
+
"addons": {
|
|
17960
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
17961
|
+
},
|
|
17962
|
+
"app_name": {
|
|
17963
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
17964
|
+
},
|
|
17965
|
+
"data": {
|
|
17966
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
17967
|
+
},
|
|
17968
|
+
"dynos": {
|
|
17969
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
17970
|
+
},
|
|
17971
|
+
"partner": {
|
|
17972
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
17973
|
+
}
|
|
17974
|
+
}
|
|
17975
|
+
},
|
|
17976
|
+
"data": {
|
|
17977
|
+
"description": "total add-on credits used for first party add-ons",
|
|
17978
|
+
"example": 34.89,
|
|
18258
17979
|
"readOnly": true,
|
|
18259
17980
|
"type": [
|
|
18260
|
-
"
|
|
17981
|
+
"number"
|
|
18261
17982
|
]
|
|
18262
17983
|
},
|
|
18263
|
-
"
|
|
18264
|
-
"description": "
|
|
18265
|
-
"example": "
|
|
17984
|
+
"date": {
|
|
17985
|
+
"description": "date of the usage",
|
|
17986
|
+
"example": "2019-01-01",
|
|
17987
|
+
"format": "date",
|
|
18266
17988
|
"readOnly": true,
|
|
18267
17989
|
"type": [
|
|
18268
17990
|
"string"
|
|
18269
17991
|
]
|
|
18270
17992
|
},
|
|
18271
|
-
"
|
|
18272
|
-
"description": "
|
|
18273
|
-
"example":
|
|
18274
|
-
"readOnly":
|
|
17993
|
+
"dynos": {
|
|
17994
|
+
"description": "dynos used",
|
|
17995
|
+
"example": 1.548,
|
|
17996
|
+
"readOnly": true,
|
|
18275
17997
|
"type": [
|
|
18276
|
-
"
|
|
17998
|
+
"number"
|
|
18277
17999
|
]
|
|
18278
18000
|
},
|
|
18279
18001
|
"id": {
|
|
18280
|
-
"description": "
|
|
18002
|
+
"description": "team identifier",
|
|
18281
18003
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
18282
18004
|
"format": "uuid",
|
|
18283
18005
|
"readOnly": true,
|
|
@@ -18285,15 +18007,179 @@ module PlatformAPI
|
|
|
18285
18007
|
"string"
|
|
18286
18008
|
]
|
|
18287
18009
|
},
|
|
18288
|
-
"
|
|
18289
|
-
"
|
|
18290
|
-
|
|
18291
|
-
|
|
18292
|
-
|
|
18293
|
-
|
|
18294
|
-
|
|
18295
|
-
|
|
18296
|
-
|
|
18010
|
+
"name": {
|
|
18011
|
+
"description": "name of the team",
|
|
18012
|
+
"example": "ops",
|
|
18013
|
+
"readOnly": true,
|
|
18014
|
+
"type": [
|
|
18015
|
+
"string"
|
|
18016
|
+
]
|
|
18017
|
+
},
|
|
18018
|
+
"partner": {
|
|
18019
|
+
"description": "total add-on credits used for third party add-ons",
|
|
18020
|
+
"example": 12.34,
|
|
18021
|
+
"readOnly": true,
|
|
18022
|
+
"type": [
|
|
18023
|
+
"number"
|
|
18024
|
+
]
|
|
18025
|
+
},
|
|
18026
|
+
"space": {
|
|
18027
|
+
"description": "space credits used",
|
|
18028
|
+
"example": 1.548,
|
|
18029
|
+
"readOnly": true,
|
|
18030
|
+
"type": [
|
|
18031
|
+
"number"
|
|
18032
|
+
]
|
|
18033
|
+
},
|
|
18034
|
+
"start_date": {
|
|
18035
|
+
"description": "range start date",
|
|
18036
|
+
"example": "2019-01-25",
|
|
18037
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
18038
|
+
"readOnly": true,
|
|
18039
|
+
"type": [
|
|
18040
|
+
"string"
|
|
18041
|
+
]
|
|
18042
|
+
},
|
|
18043
|
+
"end_date": {
|
|
18044
|
+
"description": "range end date",
|
|
18045
|
+
"example": "2019-02-25",
|
|
18046
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
18047
|
+
"readOnly": true,
|
|
18048
|
+
"type": [
|
|
18049
|
+
"string"
|
|
18050
|
+
]
|
|
18051
|
+
}
|
|
18052
|
+
},
|
|
18053
|
+
"links": [
|
|
18054
|
+
{
|
|
18055
|
+
"description": "Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format YYYY-MM-DD. The team identifier can be found from the [team list endpoint](https://devcenter.heroku.com/articles/platform-api-reference#team-list).\n",
|
|
18056
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
|
|
18057
|
+
"method": "GET",
|
|
18058
|
+
"title": "Info",
|
|
18059
|
+
"schema": {
|
|
18060
|
+
"properties": {
|
|
18061
|
+
"start": {
|
|
18062
|
+
"$ref": "#/definitions/team-daily-usage/definitions/start_date"
|
|
18063
|
+
},
|
|
18064
|
+
"end": {
|
|
18065
|
+
"$ref": "#/definitions/team-daily-usage/definitions/end_date"
|
|
18066
|
+
}
|
|
18067
|
+
},
|
|
18068
|
+
"required": [
|
|
18069
|
+
"start"
|
|
18070
|
+
],
|
|
18071
|
+
"type": [
|
|
18072
|
+
"object"
|
|
18073
|
+
]
|
|
18074
|
+
},
|
|
18075
|
+
"rel": "instances",
|
|
18076
|
+
"targetSchema": {
|
|
18077
|
+
"items": {
|
|
18078
|
+
"$ref": "#/definitions/team-daily-usage"
|
|
18079
|
+
},
|
|
18080
|
+
"type": [
|
|
18081
|
+
"array"
|
|
18082
|
+
]
|
|
18083
|
+
}
|
|
18084
|
+
}
|
|
18085
|
+
],
|
|
18086
|
+
"properties": {
|
|
18087
|
+
"addons": {
|
|
18088
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
18089
|
+
},
|
|
18090
|
+
"apps": {
|
|
18091
|
+
"description": "app usage in the team",
|
|
18092
|
+
"type": [
|
|
18093
|
+
"array"
|
|
18094
|
+
],
|
|
18095
|
+
"items": {
|
|
18096
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
|
18097
|
+
}
|
|
18098
|
+
},
|
|
18099
|
+
"data": {
|
|
18100
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
18101
|
+
},
|
|
18102
|
+
"date": {
|
|
18103
|
+
"$ref": "#/definitions/team-daily-usage/definitions/date"
|
|
18104
|
+
},
|
|
18105
|
+
"dynos": {
|
|
18106
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
18107
|
+
},
|
|
18108
|
+
"id": {
|
|
18109
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
|
18110
|
+
},
|
|
18111
|
+
"name": {
|
|
18112
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
|
18113
|
+
},
|
|
18114
|
+
"partner": {
|
|
18115
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
18116
|
+
},
|
|
18117
|
+
"space": {
|
|
18118
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
|
18119
|
+
}
|
|
18120
|
+
}
|
|
18121
|
+
},
|
|
18122
|
+
"team-feature": {
|
|
18123
|
+
"description": "A team feature represents a feature enabled on a team account.",
|
|
18124
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
18125
|
+
"stability": "development",
|
|
18126
|
+
"strictProperties": true,
|
|
18127
|
+
"title": "Heroku Platform API - Team Feature",
|
|
18128
|
+
"type": [
|
|
18129
|
+
"object"
|
|
18130
|
+
],
|
|
18131
|
+
"definitions": {
|
|
18132
|
+
"created_at": {
|
|
18133
|
+
"description": "when team feature was created",
|
|
18134
|
+
"example": "2012-01-01T12:00:00Z",
|
|
18135
|
+
"format": "date-time",
|
|
18136
|
+
"readOnly": true,
|
|
18137
|
+
"type": [
|
|
18138
|
+
"string"
|
|
18139
|
+
]
|
|
18140
|
+
},
|
|
18141
|
+
"description": {
|
|
18142
|
+
"description": "description of team feature",
|
|
18143
|
+
"example": "Causes account to example.",
|
|
18144
|
+
"readOnly": true,
|
|
18145
|
+
"type": [
|
|
18146
|
+
"string"
|
|
18147
|
+
]
|
|
18148
|
+
},
|
|
18149
|
+
"doc_url": {
|
|
18150
|
+
"description": "documentation URL of team feature",
|
|
18151
|
+
"example": "http://devcenter.heroku.com/articles/example",
|
|
18152
|
+
"readOnly": true,
|
|
18153
|
+
"type": [
|
|
18154
|
+
"string"
|
|
18155
|
+
]
|
|
18156
|
+
},
|
|
18157
|
+
"enabled": {
|
|
18158
|
+
"description": "whether or not team feature has been enabled",
|
|
18159
|
+
"example": true,
|
|
18160
|
+
"readOnly": false,
|
|
18161
|
+
"type": [
|
|
18162
|
+
"boolean"
|
|
18163
|
+
]
|
|
18164
|
+
},
|
|
18165
|
+
"id": {
|
|
18166
|
+
"description": "unique identifier of team feature",
|
|
18167
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
18168
|
+
"format": "uuid",
|
|
18169
|
+
"readOnly": true,
|
|
18170
|
+
"type": [
|
|
18171
|
+
"string"
|
|
18172
|
+
]
|
|
18173
|
+
},
|
|
18174
|
+
"identity": {
|
|
18175
|
+
"anyOf": [
|
|
18176
|
+
{
|
|
18177
|
+
"$ref": "#/definitions/team-feature/definitions/id"
|
|
18178
|
+
},
|
|
18179
|
+
{
|
|
18180
|
+
"$ref": "#/definitions/team-feature/definitions/name"
|
|
18181
|
+
}
|
|
18182
|
+
]
|
|
18297
18183
|
},
|
|
18298
18184
|
"name": {
|
|
18299
18185
|
"description": "unique name of team feature",
|
|
@@ -18488,6 +18374,9 @@ module PlatformAPI
|
|
|
18488
18374
|
"type": [
|
|
18489
18375
|
"object"
|
|
18490
18376
|
]
|
|
18377
|
+
},
|
|
18378
|
+
"targetSchema": {
|
|
18379
|
+
"$ref": "#/definitions/team-invitation"
|
|
18491
18380
|
}
|
|
18492
18381
|
},
|
|
18493
18382
|
{
|
|
@@ -18495,7 +18384,10 @@ module PlatformAPI
|
|
|
18495
18384
|
"title": "Revoke",
|
|
18496
18385
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Fidentity)}",
|
|
18497
18386
|
"method": "DELETE",
|
|
18498
|
-
"rel": "self"
|
|
18387
|
+
"rel": "self",
|
|
18388
|
+
"targetSchema": {
|
|
18389
|
+
"$ref": "#/definitions/team-invitation"
|
|
18390
|
+
}
|
|
18499
18391
|
},
|
|
18500
18392
|
{
|
|
18501
18393
|
"description": "Get an invitation by its token",
|
|
@@ -19115,282 +19007,7 @@ module PlatformAPI
|
|
|
19115
19007
|
}
|
|
19116
19008
|
}
|
|
19117
19009
|
},
|
|
19118
|
-
"team-
|
|
19119
|
-
"description": "Tracks a Team's Preferences",
|
|
19120
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19121
|
-
"stability": "development",
|
|
19122
|
-
"strictProperties": true,
|
|
19123
|
-
"title": "Heroku Platform API - Team Preferences",
|
|
19124
|
-
"type": [
|
|
19125
|
-
"object"
|
|
19126
|
-
],
|
|
19127
|
-
"definitions": {
|
|
19128
|
-
"default-permission": {
|
|
19129
|
-
"description": "The default permission used when adding new members to the team",
|
|
19130
|
-
"example": "member",
|
|
19131
|
-
"readOnly": false,
|
|
19132
|
-
"enum": [
|
|
19133
|
-
"admin",
|
|
19134
|
-
"member",
|
|
19135
|
-
"viewer",
|
|
19136
|
-
null
|
|
19137
|
-
],
|
|
19138
|
-
"type": [
|
|
19139
|
-
"null",
|
|
19140
|
-
"string"
|
|
19141
|
-
]
|
|
19142
|
-
},
|
|
19143
|
-
"identity": {
|
|
19144
|
-
"$ref": "#/definitions/team/definitions/identity"
|
|
19145
|
-
},
|
|
19146
|
-
"whitelisting-enabled": {
|
|
19147
|
-
"deactivate_on": "2021-02-05",
|
|
19148
|
-
"description": "Whether whitelisting rules should be applied to add-on installations. Deprecated in favor of `addons-controls`",
|
|
19149
|
-
"example": true,
|
|
19150
|
-
"readOnly": false,
|
|
19151
|
-
"type": [
|
|
19152
|
-
"boolean",
|
|
19153
|
-
"null"
|
|
19154
|
-
]
|
|
19155
|
-
},
|
|
19156
|
-
"addons-controls": {
|
|
19157
|
-
"description": "Whether add-on service rules should be applied to add-on installations",
|
|
19158
|
-
"example": true,
|
|
19159
|
-
"readOnly": false,
|
|
19160
|
-
"type": [
|
|
19161
|
-
"boolean",
|
|
19162
|
-
"null"
|
|
19163
|
-
]
|
|
19164
|
-
}
|
|
19165
|
-
},
|
|
19166
|
-
"links": [
|
|
19167
|
-
{
|
|
19168
|
-
"description": "Retrieve Team Preferences",
|
|
19169
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
19170
|
-
"method": "GET",
|
|
19171
|
-
"rel": "self",
|
|
19172
|
-
"targetSchema": {
|
|
19173
|
-
"$ref": "#/definitions/team-preferences"
|
|
19174
|
-
},
|
|
19175
|
-
"title": "List"
|
|
19176
|
-
},
|
|
19177
|
-
{
|
|
19178
|
-
"description": "Update Team Preferences",
|
|
19179
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
19180
|
-
"method": "PATCH",
|
|
19181
|
-
"rel": "update",
|
|
19182
|
-
"schema": {
|
|
19183
|
-
"type": [
|
|
19184
|
-
"object"
|
|
19185
|
-
],
|
|
19186
|
-
"properties": {
|
|
19187
|
-
"whitelisting-enabled": {
|
|
19188
|
-
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
19189
|
-
},
|
|
19190
|
-
"addons-controls": {
|
|
19191
|
-
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
19192
|
-
}
|
|
19193
|
-
}
|
|
19194
|
-
},
|
|
19195
|
-
"targetSchema": {
|
|
19196
|
-
"$ref": "#/definitions/team-preferences"
|
|
19197
|
-
},
|
|
19198
|
-
"title": "Update"
|
|
19199
|
-
}
|
|
19200
|
-
],
|
|
19201
|
-
"properties": {
|
|
19202
|
-
"default-permission": {
|
|
19203
|
-
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
|
19204
|
-
},
|
|
19205
|
-
"whitelisting-enabled": {
|
|
19206
|
-
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
19207
|
-
},
|
|
19208
|
-
"addons-controls": {
|
|
19209
|
-
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
19210
|
-
}
|
|
19211
|
-
}
|
|
19212
|
-
},
|
|
19213
|
-
"team-space": {
|
|
19214
|
-
"description": "A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.",
|
|
19215
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19216
|
-
"stability": "prototype",
|
|
19217
|
-
"strictProperties": true,
|
|
19218
|
-
"title": "Heroku Platform API - Space",
|
|
19219
|
-
"type": [
|
|
19220
|
-
"object"
|
|
19221
|
-
],
|
|
19222
|
-
"links": [
|
|
19223
|
-
{
|
|
19224
|
-
"description": "List spaces owned by the team",
|
|
19225
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/spaces",
|
|
19226
|
-
"method": "GET",
|
|
19227
|
-
"rel": "instances",
|
|
19228
|
-
"targetSchema": {
|
|
19229
|
-
"items": {
|
|
19230
|
-
"$ref": "#/definitions/space"
|
|
19231
|
-
},
|
|
19232
|
-
"type": [
|
|
19233
|
-
"array"
|
|
19234
|
-
]
|
|
19235
|
-
},
|
|
19236
|
-
"title": "List"
|
|
19237
|
-
}
|
|
19238
|
-
]
|
|
19239
|
-
},
|
|
19240
|
-
"team-usage-daily": {
|
|
19241
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19242
|
-
"description": "Usage for an enterprise team at a daily resolution.",
|
|
19243
|
-
"stability": "development",
|
|
19244
|
-
"strictProperties": true,
|
|
19245
|
-
"title": "Heroku Platform API - Team Daily Usage",
|
|
19246
|
-
"type": [
|
|
19247
|
-
"object"
|
|
19248
|
-
],
|
|
19249
|
-
"definitions": {
|
|
19250
|
-
"addons": {
|
|
19251
|
-
"description": "total add-on credits used",
|
|
19252
|
-
"example": 250.0,
|
|
19253
|
-
"readOnly": true,
|
|
19254
|
-
"type": [
|
|
19255
|
-
"number"
|
|
19256
|
-
]
|
|
19257
|
-
},
|
|
19258
|
-
"app_usage_daily": {
|
|
19259
|
-
"description": "Usage for an app at a daily resolution.",
|
|
19260
|
-
"type": [
|
|
19261
|
-
"object"
|
|
19262
|
-
],
|
|
19263
|
-
"properties": {
|
|
19264
|
-
"addons": {
|
|
19265
|
-
"$ref": "#/definitions/team-usage-daily/definitions/addons"
|
|
19266
|
-
},
|
|
19267
|
-
"app_name": {
|
|
19268
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
19269
|
-
},
|
|
19270
|
-
"data": {
|
|
19271
|
-
"$ref": "#/definitions/team-usage-daily/definitions/data"
|
|
19272
|
-
},
|
|
19273
|
-
"dynos": {
|
|
19274
|
-
"$ref": "#/definitions/team-usage-daily/definitions/dynos"
|
|
19275
|
-
},
|
|
19276
|
-
"partner": {
|
|
19277
|
-
"$ref": "#/definitions/team-usage-daily/definitions/partner"
|
|
19278
|
-
}
|
|
19279
|
-
}
|
|
19280
|
-
},
|
|
19281
|
-
"data": {
|
|
19282
|
-
"description": "total add-on credits used for first party add-ons",
|
|
19283
|
-
"example": 34.89,
|
|
19284
|
-
"readOnly": true,
|
|
19285
|
-
"type": [
|
|
19286
|
-
"number"
|
|
19287
|
-
]
|
|
19288
|
-
},
|
|
19289
|
-
"date": {
|
|
19290
|
-
"description": "date of the usage",
|
|
19291
|
-
"example": "2019-01-01",
|
|
19292
|
-
"format": "date",
|
|
19293
|
-
"readOnly": true,
|
|
19294
|
-
"type": [
|
|
19295
|
-
"string"
|
|
19296
|
-
]
|
|
19297
|
-
},
|
|
19298
|
-
"dynos": {
|
|
19299
|
-
"description": "dynos used",
|
|
19300
|
-
"example": 1.548,
|
|
19301
|
-
"readOnly": true,
|
|
19302
|
-
"type": [
|
|
19303
|
-
"number"
|
|
19304
|
-
]
|
|
19305
|
-
},
|
|
19306
|
-
"id": {
|
|
19307
|
-
"description": "team identifier",
|
|
19308
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
19309
|
-
"format": "uuid",
|
|
19310
|
-
"readOnly": true,
|
|
19311
|
-
"type": [
|
|
19312
|
-
"string"
|
|
19313
|
-
]
|
|
19314
|
-
},
|
|
19315
|
-
"name": {
|
|
19316
|
-
"description": "name of the team",
|
|
19317
|
-
"example": "ops",
|
|
19318
|
-
"readOnly": true,
|
|
19319
|
-
"type": [
|
|
19320
|
-
"string"
|
|
19321
|
-
]
|
|
19322
|
-
},
|
|
19323
|
-
"partner": {
|
|
19324
|
-
"description": "total add-on credits used for third party add-ons",
|
|
19325
|
-
"example": 12.34,
|
|
19326
|
-
"readOnly": true,
|
|
19327
|
-
"type": [
|
|
19328
|
-
"number"
|
|
19329
|
-
]
|
|
19330
|
-
},
|
|
19331
|
-
"space": {
|
|
19332
|
-
"description": "space credits used",
|
|
19333
|
-
"example": 1.548,
|
|
19334
|
-
"readOnly": true,
|
|
19335
|
-
"type": [
|
|
19336
|
-
"number"
|
|
19337
|
-
]
|
|
19338
|
-
}
|
|
19339
|
-
},
|
|
19340
|
-
"links": [
|
|
19341
|
-
{
|
|
19342
|
-
"description": "Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/teams/example-team/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.",
|
|
19343
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
|
|
19344
|
-
"method": "GET",
|
|
19345
|
-
"title": "Info",
|
|
19346
|
-
"rel": "instances",
|
|
19347
|
-
"targetSchema": {
|
|
19348
|
-
"items": {
|
|
19349
|
-
"$ref": "#/definitions/team-usage-daily"
|
|
19350
|
-
},
|
|
19351
|
-
"type": [
|
|
19352
|
-
"array"
|
|
19353
|
-
]
|
|
19354
|
-
}
|
|
19355
|
-
}
|
|
19356
|
-
],
|
|
19357
|
-
"properties": {
|
|
19358
|
-
"addons": {
|
|
19359
|
-
"$ref": "#/definitions/team-usage-daily/definitions/addons"
|
|
19360
|
-
},
|
|
19361
|
-
"apps": {
|
|
19362
|
-
"description": "app usage in the team",
|
|
19363
|
-
"type": [
|
|
19364
|
-
"array"
|
|
19365
|
-
],
|
|
19366
|
-
"items": {
|
|
19367
|
-
"$ref": "#/definitions/team-usage-daily/definitions/app_usage_daily"
|
|
19368
|
-
}
|
|
19369
|
-
},
|
|
19370
|
-
"data": {
|
|
19371
|
-
"$ref": "#/definitions/team-usage-daily/definitions/data"
|
|
19372
|
-
},
|
|
19373
|
-
"date": {
|
|
19374
|
-
"$ref": "#/definitions/team-usage-daily/definitions/date"
|
|
19375
|
-
},
|
|
19376
|
-
"dynos": {
|
|
19377
|
-
"$ref": "#/definitions/team-usage-daily/definitions/dynos"
|
|
19378
|
-
},
|
|
19379
|
-
"id": {
|
|
19380
|
-
"$ref": "#/definitions/team-usage-daily/definitions/id"
|
|
19381
|
-
},
|
|
19382
|
-
"name": {
|
|
19383
|
-
"$ref": "#/definitions/team-usage-daily/definitions/name"
|
|
19384
|
-
},
|
|
19385
|
-
"partner": {
|
|
19386
|
-
"$ref": "#/definitions/team-usage-daily/definitions/partner"
|
|
19387
|
-
},
|
|
19388
|
-
"space": {
|
|
19389
|
-
"$ref": "#/definitions/team-usage-daily/definitions/space"
|
|
19390
|
-
}
|
|
19391
|
-
}
|
|
19392
|
-
},
|
|
19393
|
-
"team-usage-monthly": {
|
|
19010
|
+
"team-monthly-usage": {
|
|
19394
19011
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19395
19012
|
"description": "Usage for an enterprise team at a monthly resolution.",
|
|
19396
19013
|
"stability": "development",
|
|
@@ -19415,19 +19032,19 @@ module PlatformAPI
|
|
|
19415
19032
|
],
|
|
19416
19033
|
"properties": {
|
|
19417
19034
|
"addons": {
|
|
19418
|
-
"$ref": "#/definitions/team-usage
|
|
19035
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
19419
19036
|
},
|
|
19420
19037
|
"app_name": {
|
|
19421
19038
|
"$ref": "#/definitions/app/definitions/name"
|
|
19422
19039
|
},
|
|
19423
19040
|
"data": {
|
|
19424
|
-
"$ref": "#/definitions/team-usage
|
|
19041
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
19425
19042
|
},
|
|
19426
19043
|
"dynos": {
|
|
19427
|
-
"$ref": "#/definitions/team-usage
|
|
19044
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
19428
19045
|
},
|
|
19429
19046
|
"partner": {
|
|
19430
|
-
"$ref": "#/definitions/team-usage
|
|
19047
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
19431
19048
|
}
|
|
19432
19049
|
}
|
|
19433
19050
|
},
|
|
@@ -19496,18 +19113,52 @@ module PlatformAPI
|
|
|
19496
19113
|
"type": [
|
|
19497
19114
|
"number"
|
|
19498
19115
|
]
|
|
19116
|
+
},
|
|
19117
|
+
"start_date": {
|
|
19118
|
+
"description": "range start date",
|
|
19119
|
+
"example": "2019-01",
|
|
19120
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
19121
|
+
"readOnly": true,
|
|
19122
|
+
"type": [
|
|
19123
|
+
"string"
|
|
19124
|
+
]
|
|
19125
|
+
},
|
|
19126
|
+
"end_date": {
|
|
19127
|
+
"description": "range end date",
|
|
19128
|
+
"example": "2019-02",
|
|
19129
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
19130
|
+
"readOnly": true,
|
|
19131
|
+
"type": [
|
|
19132
|
+
"string"
|
|
19133
|
+
]
|
|
19499
19134
|
}
|
|
19500
19135
|
},
|
|
19501
19136
|
"links": [
|
|
19502
19137
|
{
|
|
19503
|
-
"description": "Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date
|
|
19138
|
+
"description": "Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date, YYYY-MM. If no end date is specified, one month of usage is returned. The team identifier can be found from the [team list endpoint](https://devcenter.heroku.com/articles/platform-api-reference#team-list).\n",
|
|
19504
19139
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/monthly",
|
|
19505
19140
|
"method": "GET",
|
|
19506
19141
|
"title": "Info",
|
|
19142
|
+
"schema": {
|
|
19143
|
+
"properties": {
|
|
19144
|
+
"start": {
|
|
19145
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/start_date"
|
|
19146
|
+
},
|
|
19147
|
+
"end": {
|
|
19148
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/end_date"
|
|
19149
|
+
}
|
|
19150
|
+
},
|
|
19151
|
+
"required": [
|
|
19152
|
+
"start"
|
|
19153
|
+
],
|
|
19154
|
+
"type": [
|
|
19155
|
+
"object"
|
|
19156
|
+
]
|
|
19157
|
+
},
|
|
19507
19158
|
"rel": "instances",
|
|
19508
19159
|
"targetSchema": {
|
|
19509
19160
|
"items": {
|
|
19510
|
-
"$ref": "#/definitions/team-usage
|
|
19161
|
+
"$ref": "#/definitions/team-monthly-usage"
|
|
19511
19162
|
},
|
|
19512
19163
|
"type": [
|
|
19513
19164
|
"array"
|
|
@@ -19517,7 +19168,7 @@ module PlatformAPI
|
|
|
19517
19168
|
],
|
|
19518
19169
|
"properties": {
|
|
19519
19170
|
"addons": {
|
|
19520
|
-
"$ref": "#/definitions/team-usage
|
|
19171
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
19521
19172
|
},
|
|
19522
19173
|
"apps": {
|
|
19523
19174
|
"description": "app usage in the team",
|
|
@@ -19525,35 +19176,141 @@ module PlatformAPI
|
|
|
19525
19176
|
"array"
|
|
19526
19177
|
],
|
|
19527
19178
|
"items": {
|
|
19528
|
-
"$ref": "#/definitions/team-usage
|
|
19179
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
|
19529
19180
|
}
|
|
19530
19181
|
},
|
|
19531
19182
|
"connect": {
|
|
19532
|
-
"$ref": "#/definitions/team-usage
|
|
19183
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
|
19533
19184
|
},
|
|
19534
19185
|
"data": {
|
|
19535
|
-
"$ref": "#/definitions/team-usage
|
|
19186
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
19536
19187
|
},
|
|
19537
19188
|
"dynos": {
|
|
19538
|
-
"$ref": "#/definitions/team-usage
|
|
19189
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
19539
19190
|
},
|
|
19540
19191
|
"id": {
|
|
19541
|
-
"$ref": "#/definitions/team-usage
|
|
19192
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
|
19542
19193
|
},
|
|
19543
19194
|
"month": {
|
|
19544
|
-
"$ref": "#/definitions/team-usage
|
|
19195
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/month"
|
|
19545
19196
|
},
|
|
19546
19197
|
"name": {
|
|
19547
|
-
"$ref": "#/definitions/team-usage
|
|
19198
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
|
19548
19199
|
},
|
|
19549
19200
|
"partner": {
|
|
19550
|
-
"$ref": "#/definitions/team-usage
|
|
19201
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
19551
19202
|
},
|
|
19552
19203
|
"space": {
|
|
19553
|
-
"$ref": "#/definitions/team-usage
|
|
19204
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
|
19205
|
+
}
|
|
19206
|
+
}
|
|
19207
|
+
},
|
|
19208
|
+
"team-preferences": {
|
|
19209
|
+
"description": "Tracks a Team's Preferences",
|
|
19210
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19211
|
+
"stability": "development",
|
|
19212
|
+
"strictProperties": true,
|
|
19213
|
+
"title": "Heroku Platform API - Team Preferences",
|
|
19214
|
+
"type": [
|
|
19215
|
+
"object"
|
|
19216
|
+
],
|
|
19217
|
+
"definitions": {
|
|
19218
|
+
"default-permission": {
|
|
19219
|
+
"description": "The default permission used when adding new members to the team",
|
|
19220
|
+
"example": "member",
|
|
19221
|
+
"readOnly": false,
|
|
19222
|
+
"enum": [
|
|
19223
|
+
"admin",
|
|
19224
|
+
"member",
|
|
19225
|
+
"viewer",
|
|
19226
|
+
null
|
|
19227
|
+
],
|
|
19228
|
+
"type": [
|
|
19229
|
+
"null",
|
|
19230
|
+
"string"
|
|
19231
|
+
]
|
|
19232
|
+
},
|
|
19233
|
+
"identity": {
|
|
19234
|
+
"$ref": "#/definitions/team/definitions/identity"
|
|
19235
|
+
},
|
|
19236
|
+
"addons-controls": {
|
|
19237
|
+
"description": "Whether add-on service rules should be applied to add-on installations",
|
|
19238
|
+
"example": true,
|
|
19239
|
+
"readOnly": false,
|
|
19240
|
+
"type": [
|
|
19241
|
+
"boolean",
|
|
19242
|
+
"null"
|
|
19243
|
+
]
|
|
19244
|
+
}
|
|
19245
|
+
},
|
|
19246
|
+
"links": [
|
|
19247
|
+
{
|
|
19248
|
+
"description": "Retrieve Team Preferences",
|
|
19249
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
19250
|
+
"method": "GET",
|
|
19251
|
+
"rel": "self",
|
|
19252
|
+
"targetSchema": {
|
|
19253
|
+
"$ref": "#/definitions/team-preferences"
|
|
19254
|
+
},
|
|
19255
|
+
"title": "List"
|
|
19256
|
+
},
|
|
19257
|
+
{
|
|
19258
|
+
"description": "Update Team Preferences",
|
|
19259
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
19260
|
+
"method": "PATCH",
|
|
19261
|
+
"rel": "update",
|
|
19262
|
+
"schema": {
|
|
19263
|
+
"type": [
|
|
19264
|
+
"object"
|
|
19265
|
+
],
|
|
19266
|
+
"properties": {
|
|
19267
|
+
"addons-controls": {
|
|
19268
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
19269
|
+
}
|
|
19270
|
+
}
|
|
19271
|
+
},
|
|
19272
|
+
"targetSchema": {
|
|
19273
|
+
"$ref": "#/definitions/team-preferences"
|
|
19274
|
+
},
|
|
19275
|
+
"title": "Update"
|
|
19276
|
+
}
|
|
19277
|
+
],
|
|
19278
|
+
"properties": {
|
|
19279
|
+
"default-permission": {
|
|
19280
|
+
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
|
19281
|
+
},
|
|
19282
|
+
"addons-controls": {
|
|
19283
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
19554
19284
|
}
|
|
19555
19285
|
}
|
|
19556
19286
|
},
|
|
19287
|
+
"team-space": {
|
|
19288
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
|
19289
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19290
|
+
"stability": "prototype",
|
|
19291
|
+
"strictProperties": true,
|
|
19292
|
+
"title": "Heroku Platform API - Team Space",
|
|
19293
|
+
"type": [
|
|
19294
|
+
"object"
|
|
19295
|
+
],
|
|
19296
|
+
"links": [
|
|
19297
|
+
{
|
|
19298
|
+
"description": "List spaces owned by the team",
|
|
19299
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/spaces",
|
|
19300
|
+
"method": "GET",
|
|
19301
|
+
"rel": "instances",
|
|
19302
|
+
"targetSchema": {
|
|
19303
|
+
"items": {
|
|
19304
|
+
"$ref": "#/definitions/space"
|
|
19305
|
+
},
|
|
19306
|
+
"type": [
|
|
19307
|
+
"array"
|
|
19308
|
+
]
|
|
19309
|
+
},
|
|
19310
|
+
"title": "List"
|
|
19311
|
+
}
|
|
19312
|
+
]
|
|
19313
|
+
},
|
|
19557
19314
|
"team": {
|
|
19558
19315
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
19559
19316
|
"description": "Teams allow you to manage access to a shared group of applications and other resources.",
|
|
@@ -19633,12 +19390,11 @@ module PlatformAPI
|
|
|
19633
19390
|
"id": {
|
|
19634
19391
|
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
19635
19392
|
},
|
|
19636
|
-
"
|
|
19637
|
-
"
|
|
19638
|
-
|
|
19639
|
-
|
|
19640
|
-
|
|
19641
|
-
]
|
|
19393
|
+
"name": {
|
|
19394
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
19395
|
+
},
|
|
19396
|
+
"owner": {
|
|
19397
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
19642
19398
|
}
|
|
19643
19399
|
}
|
|
19644
19400
|
},
|
|
@@ -19839,6 +19595,9 @@ module PlatformAPI
|
|
|
19839
19595
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
|
19840
19596
|
"method": "GET",
|
|
19841
19597
|
"rel": "self",
|
|
19598
|
+
"targetSchema": {
|
|
19599
|
+
"$ref": "#/definitions/team"
|
|
19600
|
+
},
|
|
19842
19601
|
"title": "Info"
|
|
19843
19602
|
},
|
|
19844
19603
|
{
|
|
@@ -21106,6 +20865,9 @@ module PlatformAPI
|
|
|
21106
20865
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/vpn-connections/{(%23%2Fdefinitions%2Fvpn-connection%2Fdefinitions%2Fidentity)}",
|
|
21107
20866
|
"rel": "empty",
|
|
21108
20867
|
"method": "DELETE",
|
|
20868
|
+
"targetSchema": {
|
|
20869
|
+
"$ref": "#/definitions/vpn-connection"
|
|
20870
|
+
},
|
|
21109
20871
|
"title": "Destroy"
|
|
21110
20872
|
},
|
|
21111
20873
|
{
|
|
@@ -21157,160 +20919,6 @@ module PlatformAPI
|
|
|
21157
20919
|
"title": "Update"
|
|
21158
20920
|
}
|
|
21159
20921
|
]
|
|
21160
|
-
},
|
|
21161
|
-
"whitelisted-add-on-service": {
|
|
21162
|
-
"description": "Entities that have been whitelisted to be used by a Team. Deprecated in favor of [Allowed Add-on Service](#allowed-add-on-service) endpoints.",
|
|
21163
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
21164
|
-
"stability": "prototype",
|
|
21165
|
-
"strictProperties": true,
|
|
21166
|
-
"title": "Heroku Platform API - Whitelisted Entity",
|
|
21167
|
-
"type": [
|
|
21168
|
-
"object"
|
|
21169
|
-
],
|
|
21170
|
-
"definitions": {
|
|
21171
|
-
"added_at": {
|
|
21172
|
-
"description": "when the add-on service was whitelisted",
|
|
21173
|
-
"example": "2012-01-01T12:00:00Z",
|
|
21174
|
-
"format": "date-time",
|
|
21175
|
-
"readOnly": true,
|
|
21176
|
-
"type": [
|
|
21177
|
-
"string"
|
|
21178
|
-
]
|
|
21179
|
-
},
|
|
21180
|
-
"added_by": {
|
|
21181
|
-
"description": "the user which whitelisted the Add-on Service",
|
|
21182
|
-
"properties": {
|
|
21183
|
-
"email": {
|
|
21184
|
-
"$ref": "#/definitions/account/definitions/email",
|
|
21185
|
-
"type": [
|
|
21186
|
-
"string",
|
|
21187
|
-
"null"
|
|
21188
|
-
]
|
|
21189
|
-
},
|
|
21190
|
-
"id": {
|
|
21191
|
-
"$ref": "#/definitions/account/definitions/id",
|
|
21192
|
-
"type": [
|
|
21193
|
-
"string",
|
|
21194
|
-
"null"
|
|
21195
|
-
]
|
|
21196
|
-
}
|
|
21197
|
-
},
|
|
21198
|
-
"readOnly": true,
|
|
21199
|
-
"type": [
|
|
21200
|
-
"object"
|
|
21201
|
-
]
|
|
21202
|
-
},
|
|
21203
|
-
"addon_service": {
|
|
21204
|
-
"description": "the Add-on Service whitelisted for use",
|
|
21205
|
-
"properties": {
|
|
21206
|
-
"id": {
|
|
21207
|
-
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
21208
|
-
},
|
|
21209
|
-
"name": {
|
|
21210
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
21211
|
-
},
|
|
21212
|
-
"human_name": {
|
|
21213
|
-
"$ref": "#/definitions/add-on-service/definitions/human_name"
|
|
21214
|
-
}
|
|
21215
|
-
},
|
|
21216
|
-
"readOnly": true,
|
|
21217
|
-
"type": [
|
|
21218
|
-
"object"
|
|
21219
|
-
]
|
|
21220
|
-
},
|
|
21221
|
-
"id": {
|
|
21222
|
-
"description": "unique identifier for this whitelisting entity",
|
|
21223
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
21224
|
-
"format": "uuid",
|
|
21225
|
-
"readOnly": true,
|
|
21226
|
-
"type": [
|
|
21227
|
-
"string"
|
|
21228
|
-
]
|
|
21229
|
-
},
|
|
21230
|
-
"identity": {
|
|
21231
|
-
"anyOf": [
|
|
21232
|
-
{
|
|
21233
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/id"
|
|
21234
|
-
},
|
|
21235
|
-
{
|
|
21236
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
21237
|
-
}
|
|
21238
|
-
]
|
|
21239
|
-
}
|
|
21240
|
-
},
|
|
21241
|
-
"links": [
|
|
21242
|
-
{
|
|
21243
|
-
"deactivate_on": "2021-02-05",
|
|
21244
|
-
"description": "List all whitelisted Add-on Services for a Team - Deprecated in favor of [`GET /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-list-by-team) endpoint.",
|
|
21245
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
21246
|
-
"method": "GET",
|
|
21247
|
-
"rel": "instances",
|
|
21248
|
-
"targetSchema": {
|
|
21249
|
-
"items": {
|
|
21250
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
21251
|
-
},
|
|
21252
|
-
"type": [
|
|
21253
|
-
"array"
|
|
21254
|
-
]
|
|
21255
|
-
},
|
|
21256
|
-
"title": "List By Team - Deprecated"
|
|
21257
|
-
},
|
|
21258
|
-
{
|
|
21259
|
-
"deactivate_on": "2021-02-05",
|
|
21260
|
-
"description": "Whitelist an Add-on Service - Deprecated in favor of [`POST /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-create-by-team) endpoint.",
|
|
21261
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
21262
|
-
"method": "POST",
|
|
21263
|
-
"rel": "create",
|
|
21264
|
-
"schema": {
|
|
21265
|
-
"type": [
|
|
21266
|
-
"object"
|
|
21267
|
-
],
|
|
21268
|
-
"properties": {
|
|
21269
|
-
"addon_service": {
|
|
21270
|
-
"description": "name of the Add-on to whitelist",
|
|
21271
|
-
"example": "heroku-postgresql",
|
|
21272
|
-
"type": [
|
|
21273
|
-
"string"
|
|
21274
|
-
]
|
|
21275
|
-
}
|
|
21276
|
-
}
|
|
21277
|
-
},
|
|
21278
|
-
"targetSchema": {
|
|
21279
|
-
"items": {
|
|
21280
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
21281
|
-
},
|
|
21282
|
-
"type": [
|
|
21283
|
-
"array"
|
|
21284
|
-
]
|
|
21285
|
-
},
|
|
21286
|
-
"title": "Create By Team - Deprecated"
|
|
21287
|
-
},
|
|
21288
|
-
{
|
|
21289
|
-
"deactivate_on": "2021-02-05",
|
|
21290
|
-
"description": "Remove a whitelisted entity - Deprecated in favor of [`DELETE /teams/{team_name_or_id}/allowed-addon-services/{allowed_add_on_service_id_or_name}`](#allowed-add-on-service-delete-by-team) endpoint.",
|
|
21291
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services/{(%23%2Fdefinitions%2Fwhitelisted-add-on-service%2Fdefinitions%2Fidentity)}",
|
|
21292
|
-
"method": "DELETE",
|
|
21293
|
-
"rel": "destroy",
|
|
21294
|
-
"targetSchema": {
|
|
21295
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
21296
|
-
},
|
|
21297
|
-
"title": "Delete By Team - Deprecated"
|
|
21298
|
-
}
|
|
21299
|
-
],
|
|
21300
|
-
"properties": {
|
|
21301
|
-
"added_at": {
|
|
21302
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/added_at"
|
|
21303
|
-
},
|
|
21304
|
-
"added_by": {
|
|
21305
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/added_by"
|
|
21306
|
-
},
|
|
21307
|
-
"addon_service": {
|
|
21308
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/addon_service"
|
|
21309
|
-
},
|
|
21310
|
-
"id": {
|
|
21311
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/id"
|
|
21312
|
-
}
|
|
21313
|
-
}
|
|
21314
20922
|
}
|
|
21315
20923
|
},
|
|
21316
20924
|
"properties": {
|
|
@@ -21356,9 +20964,6 @@ module PlatformAPI
|
|
|
21356
20964
|
"app-feature": {
|
|
21357
20965
|
"$ref": "#/definitions/app-feature"
|
|
21358
20966
|
},
|
|
21359
|
-
"app-formation-set": {
|
|
21360
|
-
"$ref": "#/definitions/app-formation-set"
|
|
21361
|
-
},
|
|
21362
20967
|
"app-setup": {
|
|
21363
20968
|
"$ref": "#/definitions/app-setup"
|
|
21364
20969
|
},
|
|
@@ -21407,14 +21012,14 @@ module PlatformAPI
|
|
|
21407
21012
|
"dyno": {
|
|
21408
21013
|
"$ref": "#/definitions/dyno"
|
|
21409
21014
|
},
|
|
21015
|
+
"enterprise-account-daily-usage": {
|
|
21016
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
|
21017
|
+
},
|
|
21410
21018
|
"enterprise-account-member": {
|
|
21411
21019
|
"$ref": "#/definitions/enterprise-account-member"
|
|
21412
21020
|
},
|
|
21413
|
-
"enterprise-account-usage
|
|
21414
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
21415
|
-
},
|
|
21416
|
-
"enterprise-account-usage-monthly": {
|
|
21417
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly"
|
|
21021
|
+
"enterprise-account-monthly-usage": {
|
|
21022
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
|
21418
21023
|
},
|
|
21419
21024
|
"enterprise-account": {
|
|
21420
21025
|
"$ref": "#/definitions/enterprise-account"
|
|
@@ -21548,9 +21153,6 @@ module PlatformAPI
|
|
|
21548
21153
|
"space": {
|
|
21549
21154
|
"$ref": "#/definitions/space"
|
|
21550
21155
|
},
|
|
21551
|
-
"ssl-endpoint": {
|
|
21552
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
21553
|
-
},
|
|
21554
21156
|
"stack": {
|
|
21555
21157
|
"$ref": "#/definitions/stack"
|
|
21556
21158
|
},
|
|
@@ -21566,6 +21168,9 @@ module PlatformAPI
|
|
|
21566
21168
|
"team-app": {
|
|
21567
21169
|
"$ref": "#/definitions/team-app"
|
|
21568
21170
|
},
|
|
21171
|
+
"team-daily-usage": {
|
|
21172
|
+
"$ref": "#/definitions/team-daily-usage"
|
|
21173
|
+
},
|
|
21569
21174
|
"team-feature": {
|
|
21570
21175
|
"$ref": "#/definitions/team-feature"
|
|
21571
21176
|
},
|
|
@@ -21578,18 +21183,15 @@ module PlatformAPI
|
|
|
21578
21183
|
"team-member": {
|
|
21579
21184
|
"$ref": "#/definitions/team-member"
|
|
21580
21185
|
},
|
|
21186
|
+
"team-monthly-usage": {
|
|
21187
|
+
"$ref": "#/definitions/team-monthly-usage"
|
|
21188
|
+
},
|
|
21581
21189
|
"team-preferences": {
|
|
21582
21190
|
"$ref": "#/definitions/team-preferences"
|
|
21583
21191
|
},
|
|
21584
21192
|
"team-space": {
|
|
21585
21193
|
"$ref": "#/definitions/team-space"
|
|
21586
21194
|
},
|
|
21587
|
-
"team-usage-daily": {
|
|
21588
|
-
"$ref": "#/definitions/team-usage-daily"
|
|
21589
|
-
},
|
|
21590
|
-
"team-usage-monthly": {
|
|
21591
|
-
"$ref": "#/definitions/team-usage-monthly"
|
|
21592
|
-
},
|
|
21593
21195
|
"team": {
|
|
21594
21196
|
"$ref": "#/definitions/team"
|
|
21595
21197
|
},
|
|
@@ -21607,9 +21209,6 @@ module PlatformAPI
|
|
|
21607
21209
|
},
|
|
21608
21210
|
"vpn-connection": {
|
|
21609
21211
|
"$ref": "#/definitions/vpn-connection"
|
|
21610
|
-
},
|
|
21611
|
-
"whitelisted-add-on-service": {
|
|
21612
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
21613
21212
|
}
|
|
21614
21213
|
},
|
|
21615
21214
|
"description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",
|