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/schema.json
CHANGED
|
@@ -368,46 +368,6 @@
|
|
|
368
368
|
"type": [
|
|
369
369
|
"boolean"
|
|
370
370
|
]
|
|
371
|
-
},
|
|
372
|
-
"acknowledged_msa": {
|
|
373
|
-
"deprecated": true,
|
|
374
|
-
"description": "deprecated. whether account has acknowledged the MSA terms of service",
|
|
375
|
-
"example": false,
|
|
376
|
-
"readOnly": true,
|
|
377
|
-
"type": [
|
|
378
|
-
"boolean"
|
|
379
|
-
]
|
|
380
|
-
},
|
|
381
|
-
"acknowledged_msa_at": {
|
|
382
|
-
"deprecated": true,
|
|
383
|
-
"description": "deprecated. when account has acknowledged the MSA terms of service",
|
|
384
|
-
"example": "2012-01-01T12:00:00Z",
|
|
385
|
-
"format": "date-time",
|
|
386
|
-
"readOnly": true,
|
|
387
|
-
"type": [
|
|
388
|
-
"string",
|
|
389
|
-
"null"
|
|
390
|
-
]
|
|
391
|
-
},
|
|
392
|
-
"italian_customer_terms": {
|
|
393
|
-
"deprecated": true,
|
|
394
|
-
"description": "deprecated. whether account has acknowledged the Italian customer terms of service",
|
|
395
|
-
"example": "affirmatively_accepted",
|
|
396
|
-
"readOnly": true,
|
|
397
|
-
"type": [
|
|
398
|
-
"string",
|
|
399
|
-
"null"
|
|
400
|
-
]
|
|
401
|
-
},
|
|
402
|
-
"italian_partner_terms": {
|
|
403
|
-
"deprecated": true,
|
|
404
|
-
"description": "deprecated. whether account has acknowledged the Italian provider terms of service",
|
|
405
|
-
"example": "affirmatively_accepted",
|
|
406
|
-
"readOnly": true,
|
|
407
|
-
"type": [
|
|
408
|
-
"string",
|
|
409
|
-
"null"
|
|
410
|
-
]
|
|
411
371
|
}
|
|
412
372
|
},
|
|
413
373
|
"links": [
|
|
@@ -448,7 +408,7 @@
|
|
|
448
408
|
"title": "Update"
|
|
449
409
|
},
|
|
450
410
|
{
|
|
451
|
-
"description": "Delete account. Note that this action cannot be undone.",
|
|
411
|
+
"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.",
|
|
452
412
|
"href": "/account",
|
|
453
413
|
"method": "DELETE",
|
|
454
414
|
"rel": "destroy",
|
|
@@ -494,7 +454,7 @@
|
|
|
494
454
|
"title": "Update By User"
|
|
495
455
|
},
|
|
496
456
|
{
|
|
497
|
-
"description": "Delete account. Note that this action cannot be undone.",
|
|
457
|
+
"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.",
|
|
498
458
|
"href": "/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}",
|
|
499
459
|
"method": "DELETE",
|
|
500
460
|
"rel": "destroy",
|
|
@@ -525,10 +485,14 @@
|
|
|
525
485
|
},
|
|
526
486
|
"identity_provider": {
|
|
527
487
|
"description": "Identity Provider details for federated users.",
|
|
488
|
+
"strictProperties": true,
|
|
528
489
|
"properties": {
|
|
529
490
|
"id": {
|
|
530
491
|
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
531
492
|
},
|
|
493
|
+
"name": {
|
|
494
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
495
|
+
},
|
|
532
496
|
"team": {
|
|
533
497
|
"type": [
|
|
534
498
|
"object"
|
|
@@ -550,46 +514,7 @@
|
|
|
550
514
|
}
|
|
551
515
|
},
|
|
552
516
|
"owner": {
|
|
553
|
-
"
|
|
554
|
-
"properties": {
|
|
555
|
-
"id": {
|
|
556
|
-
"description": "unique identifier of the owner",
|
|
557
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
558
|
-
"format": "uuid",
|
|
559
|
-
"readOnly": true,
|
|
560
|
-
"type": [
|
|
561
|
-
"string"
|
|
562
|
-
]
|
|
563
|
-
},
|
|
564
|
-
"name": {
|
|
565
|
-
"description": "name of the owner",
|
|
566
|
-
"example": "acme",
|
|
567
|
-
"readOnly": true,
|
|
568
|
-
"type": [
|
|
569
|
-
"string"
|
|
570
|
-
]
|
|
571
|
-
},
|
|
572
|
-
"type": {
|
|
573
|
-
"description": "type of the owner",
|
|
574
|
-
"enum": [
|
|
575
|
-
"team",
|
|
576
|
-
"enterprise-account"
|
|
577
|
-
],
|
|
578
|
-
"example": "team",
|
|
579
|
-
"readOnly": true,
|
|
580
|
-
"type": [
|
|
581
|
-
"string"
|
|
582
|
-
]
|
|
583
|
-
}
|
|
584
|
-
},
|
|
585
|
-
"readOnly": false,
|
|
586
|
-
"required": [
|
|
587
|
-
"id",
|
|
588
|
-
"type"
|
|
589
|
-
],
|
|
590
|
-
"type": [
|
|
591
|
-
"object"
|
|
592
|
-
]
|
|
517
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
593
518
|
}
|
|
594
519
|
},
|
|
595
520
|
"type": [
|
|
@@ -621,18 +546,6 @@
|
|
|
621
546
|
"verified": {
|
|
622
547
|
"$ref": "#/definitions/account/definitions/verified"
|
|
623
548
|
},
|
|
624
|
-
"acknowledged_msa": {
|
|
625
|
-
"$ref": "#/definitions/account/definitions/acknowledged_msa"
|
|
626
|
-
},
|
|
627
|
-
"acknowledged_msa_at": {
|
|
628
|
-
"$ref": "#/definitions/account/definitions/acknowledged_msa_at"
|
|
629
|
-
},
|
|
630
|
-
"italian_customer_terms": {
|
|
631
|
-
"$ref": "#/definitions/account/definitions/italian_customer_terms"
|
|
632
|
-
},
|
|
633
|
-
"italian_partner_terms": {
|
|
634
|
-
"$ref": "#/definitions/account/definitions/italian_partner_terms"
|
|
635
|
-
},
|
|
636
549
|
"country_of_residence": {
|
|
637
550
|
"$ref": "#/definitions/account/definitions/country_of_residence"
|
|
638
551
|
},
|
|
@@ -686,7 +599,7 @@
|
|
|
686
599
|
"description": "Mark an add-on as provisioned for use.",
|
|
687
600
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/provision",
|
|
688
601
|
"method": "POST",
|
|
689
|
-
"rel": "
|
|
602
|
+
"rel": "update",
|
|
690
603
|
"targetSchema": {
|
|
691
604
|
"$ref": "#/definitions/add-on"
|
|
692
605
|
},
|
|
@@ -696,7 +609,7 @@
|
|
|
696
609
|
"description": "Mark an add-on as deprovisioned.",
|
|
697
610
|
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/deprovision",
|
|
698
611
|
"method": "POST",
|
|
699
|
-
"rel": "
|
|
612
|
+
"rel": "update",
|
|
700
613
|
"targetSchema": {
|
|
701
614
|
"$ref": "#/definitions/add-on"
|
|
702
615
|
},
|
|
@@ -1709,8 +1622,24 @@
|
|
|
1709
1622
|
"description": "Add-ons represent add-ons that have been provisioned and attached to one or more apps.",
|
|
1710
1623
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
1711
1624
|
"stability": "production",
|
|
1712
|
-
"strictProperties": true,
|
|
1713
1625
|
"title": "Heroku Platform API - Add-on",
|
|
1626
|
+
"additionalProperties": false,
|
|
1627
|
+
"required": [
|
|
1628
|
+
"actions",
|
|
1629
|
+
"addon_service",
|
|
1630
|
+
"billing_entity",
|
|
1631
|
+
"app",
|
|
1632
|
+
"billed_price",
|
|
1633
|
+
"config_vars",
|
|
1634
|
+
"created_at",
|
|
1635
|
+
"id",
|
|
1636
|
+
"name",
|
|
1637
|
+
"plan",
|
|
1638
|
+
"provider_id",
|
|
1639
|
+
"state",
|
|
1640
|
+
"updated_at",
|
|
1641
|
+
"web_url"
|
|
1642
|
+
],
|
|
1714
1643
|
"type": [
|
|
1715
1644
|
"object"
|
|
1716
1645
|
],
|
|
@@ -1875,6 +1804,57 @@
|
|
|
1875
1804
|
"null",
|
|
1876
1805
|
"string"
|
|
1877
1806
|
]
|
|
1807
|
+
},
|
|
1808
|
+
"addon_service": {
|
|
1809
|
+
"description": "identity of add-on service",
|
|
1810
|
+
"anyOf": [
|
|
1811
|
+
{
|
|
1812
|
+
"properties": {
|
|
1813
|
+
"id": {
|
|
1814
|
+
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
1815
|
+
},
|
|
1816
|
+
"name": {
|
|
1817
|
+
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
1818
|
+
}
|
|
1819
|
+
},
|
|
1820
|
+
"strictProperties": true,
|
|
1821
|
+
"type": [
|
|
1822
|
+
"object"
|
|
1823
|
+
]
|
|
1824
|
+
},
|
|
1825
|
+
{
|
|
1826
|
+
"$ref": "#/definitions/add-on-service"
|
|
1827
|
+
}
|
|
1828
|
+
]
|
|
1829
|
+
},
|
|
1830
|
+
"plan": {
|
|
1831
|
+
"description": "identity of add-on plan",
|
|
1832
|
+
"anyOf": [
|
|
1833
|
+
{
|
|
1834
|
+
"properties": {
|
|
1835
|
+
"id": {
|
|
1836
|
+
"$ref": "#/definitions/plan/definitions/id"
|
|
1837
|
+
},
|
|
1838
|
+
"name": {
|
|
1839
|
+
"$ref": "#/definitions/plan/definitions/name"
|
|
1840
|
+
}
|
|
1841
|
+
},
|
|
1842
|
+
"strictProperties": true,
|
|
1843
|
+
"type": [
|
|
1844
|
+
"object"
|
|
1845
|
+
]
|
|
1846
|
+
},
|
|
1847
|
+
{
|
|
1848
|
+
"$ref": "#/definitions/plan"
|
|
1849
|
+
}
|
|
1850
|
+
]
|
|
1851
|
+
},
|
|
1852
|
+
"provision_message": {
|
|
1853
|
+
"description": "A provision message",
|
|
1854
|
+
"readOnly": true,
|
|
1855
|
+
"type": [
|
|
1856
|
+
"string"
|
|
1857
|
+
]
|
|
1878
1858
|
}
|
|
1879
1859
|
},
|
|
1880
1860
|
"links": [
|
|
@@ -2005,6 +1985,9 @@
|
|
|
2005
1985
|
"object"
|
|
2006
1986
|
]
|
|
2007
1987
|
},
|
|
1988
|
+
"targetSchema": {
|
|
1989
|
+
"$ref": "#/definitions/add-on"
|
|
1990
|
+
},
|
|
2008
1991
|
"title": "Update"
|
|
2009
1992
|
},
|
|
2010
1993
|
{
|
|
@@ -2077,19 +2060,7 @@
|
|
|
2077
2060
|
"$ref": "#/definitions/add-on/definitions/actions"
|
|
2078
2061
|
},
|
|
2079
2062
|
"addon_service": {
|
|
2080
|
-
"
|
|
2081
|
-
"properties": {
|
|
2082
|
-
"id": {
|
|
2083
|
-
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
2084
|
-
},
|
|
2085
|
-
"name": {
|
|
2086
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
2087
|
-
}
|
|
2088
|
-
},
|
|
2089
|
-
"strictProperties": true,
|
|
2090
|
-
"type": [
|
|
2091
|
-
"object"
|
|
2092
|
-
]
|
|
2063
|
+
"$ref": "#/definitions/add-on/definitions/addon_service"
|
|
2093
2064
|
},
|
|
2094
2065
|
"billing_entity": {
|
|
2095
2066
|
"description": "billing entity associated with this add-on",
|
|
@@ -2176,23 +2147,14 @@
|
|
|
2176
2147
|
"$ref": "#/definitions/add-on/definitions/name"
|
|
2177
2148
|
},
|
|
2178
2149
|
"plan": {
|
|
2179
|
-
"
|
|
2180
|
-
"properties": {
|
|
2181
|
-
"id": {
|
|
2182
|
-
"$ref": "#/definitions/plan/definitions/id"
|
|
2183
|
-
},
|
|
2184
|
-
"name": {
|
|
2185
|
-
"$ref": "#/definitions/plan/definitions/name"
|
|
2186
|
-
}
|
|
2187
|
-
},
|
|
2188
|
-
"strictProperties": true,
|
|
2189
|
-
"type": [
|
|
2190
|
-
"object"
|
|
2191
|
-
]
|
|
2150
|
+
"$ref": "#/definitions/add-on/definitions/plan"
|
|
2192
2151
|
},
|
|
2193
2152
|
"provider_id": {
|
|
2194
2153
|
"$ref": "#/definitions/add-on/definitions/provider_id"
|
|
2195
2154
|
},
|
|
2155
|
+
"provision_message": {
|
|
2156
|
+
"$ref": "#/definitions/add-on/definitions/provision_message"
|
|
2157
|
+
},
|
|
2196
2158
|
"state": {
|
|
2197
2159
|
"$ref": "#/definitions/add-on/definitions/state"
|
|
2198
2160
|
},
|
|
@@ -2542,63 +2504,6 @@
|
|
|
2542
2504
|
}
|
|
2543
2505
|
}
|
|
2544
2506
|
},
|
|
2545
|
-
"app-formation-set": {
|
|
2546
|
-
"description": "App formation set describes the combination of process types with their quantities and sizes as well as application process tier",
|
|
2547
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
2548
|
-
"stability": "development",
|
|
2549
|
-
"strictProperties": true,
|
|
2550
|
-
"title": "Heroku Platform API - Application Formation Set",
|
|
2551
|
-
"type": [
|
|
2552
|
-
"object"
|
|
2553
|
-
],
|
|
2554
|
-
"properties": {
|
|
2555
|
-
"description": {
|
|
2556
|
-
"description": "a string representation of the formation set",
|
|
2557
|
-
"example": "web@2:Standard-2X worker@3:Performance-M",
|
|
2558
|
-
"readOnly": true,
|
|
2559
|
-
"type": [
|
|
2560
|
-
"string"
|
|
2561
|
-
]
|
|
2562
|
-
},
|
|
2563
|
-
"process_tier": {
|
|
2564
|
-
"description": "application process tier",
|
|
2565
|
-
"enum": [
|
|
2566
|
-
"production",
|
|
2567
|
-
"free",
|
|
2568
|
-
"hobby",
|
|
2569
|
-
"private"
|
|
2570
|
-
],
|
|
2571
|
-
"example": "production",
|
|
2572
|
-
"readOnly": true,
|
|
2573
|
-
"type": [
|
|
2574
|
-
"string"
|
|
2575
|
-
]
|
|
2576
|
-
},
|
|
2577
|
-
"app": {
|
|
2578
|
-
"description": "app being described by the formation-set",
|
|
2579
|
-
"properties": {
|
|
2580
|
-
"name": {
|
|
2581
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
2582
|
-
},
|
|
2583
|
-
"id": {
|
|
2584
|
-
"$ref": "#/definitions/app/definitions/id"
|
|
2585
|
-
}
|
|
2586
|
-
},
|
|
2587
|
-
"type": [
|
|
2588
|
-
"object"
|
|
2589
|
-
]
|
|
2590
|
-
},
|
|
2591
|
-
"updated_at": {
|
|
2592
|
-
"description": "last time fomation-set was updated",
|
|
2593
|
-
"example": "2012-01-01T12:00:00Z",
|
|
2594
|
-
"format": "date-time",
|
|
2595
|
-
"readOnly": true,
|
|
2596
|
-
"type": [
|
|
2597
|
-
"string"
|
|
2598
|
-
]
|
|
2599
|
-
}
|
|
2600
|
-
}
|
|
2601
|
-
},
|
|
2602
2507
|
"app-setup": {
|
|
2603
2508
|
"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.",
|
|
2604
2509
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
@@ -3926,9 +3831,10 @@
|
|
|
3926
3831
|
"description": "web URL of app",
|
|
3927
3832
|
"example": "https://example.herokuapp.com/",
|
|
3928
3833
|
"format": "uri",
|
|
3929
|
-
"pattern": "^https?://[a-z][a-z0-9-]{3,
|
|
3834
|
+
"pattern": "^https?://[a-z][a-z0-9-]{3,43}\\.herokuapp\\.com/$",
|
|
3930
3835
|
"readOnly": true,
|
|
3931
3836
|
"type": [
|
|
3837
|
+
"null",
|
|
3932
3838
|
"string"
|
|
3933
3839
|
]
|
|
3934
3840
|
},
|
|
@@ -3958,6 +3864,15 @@
|
|
|
3958
3864
|
},
|
|
3959
3865
|
"stack": {
|
|
3960
3866
|
"$ref": "#/definitions/stack/definitions/identity"
|
|
3867
|
+
},
|
|
3868
|
+
"feature_flags": {
|
|
3869
|
+
"description": "unique name of app feature",
|
|
3870
|
+
"type": [
|
|
3871
|
+
"array"
|
|
3872
|
+
],
|
|
3873
|
+
"items": {
|
|
3874
|
+
"$ref": "#/definitions/app-feature/definitions/name"
|
|
3875
|
+
}
|
|
3961
3876
|
}
|
|
3962
3877
|
},
|
|
3963
3878
|
"type": [
|
|
@@ -4524,7 +4439,7 @@
|
|
|
4524
4439
|
},
|
|
4525
4440
|
"links": [
|
|
4526
4441
|
{
|
|
4527
|
-
"description": "List existing events. Returns all events for one
|
|
4442
|
+
"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.",
|
|
4528
4443
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
|
|
4529
4444
|
"method": "GET",
|
|
4530
4445
|
"rel": "instances",
|
|
@@ -4572,7 +4487,15 @@
|
|
|
4572
4487
|
"description": "A build represents the process of transforming a code tarball into a slug",
|
|
4573
4488
|
"title": "Heroku Build API - Build",
|
|
4574
4489
|
"stability": "production",
|
|
4575
|
-
"strictProperties":
|
|
4490
|
+
"strictProperties": false,
|
|
4491
|
+
"required": [
|
|
4492
|
+
"created_at",
|
|
4493
|
+
"id",
|
|
4494
|
+
"source_blob",
|
|
4495
|
+
"status",
|
|
4496
|
+
"updated_at",
|
|
4497
|
+
"user"
|
|
4498
|
+
],
|
|
4576
4499
|
"type": [
|
|
4577
4500
|
"object"
|
|
4578
4501
|
],
|
|
@@ -4695,6 +4618,15 @@
|
|
|
4695
4618
|
"string",
|
|
4696
4619
|
"null"
|
|
4697
4620
|
]
|
|
4621
|
+
},
|
|
4622
|
+
"version_description": {
|
|
4623
|
+
"description": "Version description of the gzipped tarball.",
|
|
4624
|
+
"example": "* Fake User: Change session key",
|
|
4625
|
+
"readOnly": true,
|
|
4626
|
+
"type": [
|
|
4627
|
+
"string",
|
|
4628
|
+
"null"
|
|
4629
|
+
]
|
|
4698
4630
|
}
|
|
4699
4631
|
},
|
|
4700
4632
|
"strictProperties": true,
|
|
@@ -4704,7 +4636,7 @@
|
|
|
4704
4636
|
},
|
|
4705
4637
|
"stack": {
|
|
4706
4638
|
"description": "stack of build",
|
|
4707
|
-
"example": "heroku-
|
|
4639
|
+
"example": "heroku-22",
|
|
4708
4640
|
"readOnly": true,
|
|
4709
4641
|
"type": [
|
|
4710
4642
|
"string"
|
|
@@ -4795,6 +4727,16 @@
|
|
|
4795
4727
|
"method": "DELETE",
|
|
4796
4728
|
"rel": "empty",
|
|
4797
4729
|
"title": "Delete cache"
|
|
4730
|
+
},
|
|
4731
|
+
{
|
|
4732
|
+
"description": "Cancel running build.",
|
|
4733
|
+
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}",
|
|
4734
|
+
"method": "DELETE",
|
|
4735
|
+
"rel": "self",
|
|
4736
|
+
"targetSchema": {
|
|
4737
|
+
"$ref": "#/definitions/build"
|
|
4738
|
+
},
|
|
4739
|
+
"title": "Cancel"
|
|
4798
4740
|
}
|
|
4799
4741
|
],
|
|
4800
4742
|
"properties": {
|
|
@@ -5539,30 +5481,6 @@
|
|
|
5539
5481
|
}
|
|
5540
5482
|
},
|
|
5541
5483
|
"links": [
|
|
5542
|
-
{
|
|
5543
|
-
"deactivate_on": "2021-10-31",
|
|
5544
|
-
"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.",
|
|
5545
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
|
|
5546
|
-
"method": "POST",
|
|
5547
|
-
"rel": "create",
|
|
5548
|
-
"schema": {
|
|
5549
|
-
"properties": {
|
|
5550
|
-
"hostname": {
|
|
5551
|
-
"$ref": "#/definitions/domain/definitions/hostname"
|
|
5552
|
-
}
|
|
5553
|
-
},
|
|
5554
|
-
"required": [
|
|
5555
|
-
"hostname"
|
|
5556
|
-
],
|
|
5557
|
-
"type": [
|
|
5558
|
-
"object"
|
|
5559
|
-
]
|
|
5560
|
-
},
|
|
5561
|
-
"targetSchema": {
|
|
5562
|
-
"$ref": "#/definitions/domain"
|
|
5563
|
-
},
|
|
5564
|
-
"title": "Create - Deprecated"
|
|
5565
|
-
},
|
|
5566
5484
|
{
|
|
5567
5485
|
"description": "Create a new domain.",
|
|
5568
5486
|
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
|
|
@@ -5763,7 +5681,7 @@
|
|
|
5763
5681
|
},
|
|
5764
5682
|
"name": {
|
|
5765
5683
|
"description": "the name of this dyno-size",
|
|
5766
|
-
"example": "
|
|
5684
|
+
"example": "eco",
|
|
5767
5685
|
"readOnly": true,
|
|
5768
5686
|
"type": [
|
|
5769
5687
|
"string"
|
|
@@ -5796,13 +5714,22 @@
|
|
|
5796
5714
|
}
|
|
5797
5715
|
},
|
|
5798
5716
|
"dyno_units": {
|
|
5799
|
-
"
|
|
5717
|
+
"deprecated": true,
|
|
5718
|
+
"description": "deprecated. See precise_dyno_units instead",
|
|
5800
5719
|
"example": 0,
|
|
5801
5720
|
"readOnly": true,
|
|
5802
5721
|
"type": [
|
|
5803
5722
|
"integer"
|
|
5804
5723
|
]
|
|
5805
5724
|
},
|
|
5725
|
+
"precise_dyno_units": {
|
|
5726
|
+
"description": "unit of consumption for Heroku Enterprise customers to 2 decimal places",
|
|
5727
|
+
"example": 0.28,
|
|
5728
|
+
"readOnly": true,
|
|
5729
|
+
"type": [
|
|
5730
|
+
"number"
|
|
5731
|
+
]
|
|
5732
|
+
},
|
|
5806
5733
|
"private_space_only": {
|
|
5807
5734
|
"description": "whether this dyno can only be provisioned in a private space",
|
|
5808
5735
|
"example": false,
|
|
@@ -5852,6 +5779,9 @@
|
|
|
5852
5779
|
"dyno_units": {
|
|
5853
5780
|
"$ref": "#/definitions/dyno-size/definitions/dyno_units"
|
|
5854
5781
|
},
|
|
5782
|
+
"precise_dyno_units": {
|
|
5783
|
+
"$ref": "#/definitions/dyno-size/definitions/precise_dyno_units"
|
|
5784
|
+
},
|
|
5855
5785
|
"id": {
|
|
5856
5786
|
"$ref": "#/definitions/dyno-size/definitions/id"
|
|
5857
5787
|
},
|
|
@@ -6174,19 +6104,217 @@
|
|
|
6174
6104
|
}
|
|
6175
6105
|
}
|
|
6176
6106
|
},
|
|
6177
|
-
"enterprise-account-
|
|
6107
|
+
"enterprise-account-daily-usage": {
|
|
6178
6108
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6179
|
-
"description": "
|
|
6109
|
+
"description": "Usage for an enterprise account at a daily resolution.",
|
|
6180
6110
|
"stability": "development",
|
|
6181
6111
|
"strictProperties": true,
|
|
6182
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
6112
|
+
"title": "Heroku Platform API - Enterprise Account Daily Usage",
|
|
6183
6113
|
"type": [
|
|
6184
6114
|
"object"
|
|
6185
6115
|
],
|
|
6186
6116
|
"definitions": {
|
|
6187
|
-
"
|
|
6188
|
-
"description": "
|
|
6189
|
-
"example":
|
|
6117
|
+
"addons": {
|
|
6118
|
+
"description": "total add-on credits used",
|
|
6119
|
+
"example": 250.0,
|
|
6120
|
+
"readOnly": true,
|
|
6121
|
+
"type": [
|
|
6122
|
+
"number"
|
|
6123
|
+
]
|
|
6124
|
+
},
|
|
6125
|
+
"data": {
|
|
6126
|
+
"description": "total add-on credits used for first party add-ons",
|
|
6127
|
+
"example": 34.89,
|
|
6128
|
+
"readOnly": true,
|
|
6129
|
+
"type": [
|
|
6130
|
+
"number"
|
|
6131
|
+
]
|
|
6132
|
+
},
|
|
6133
|
+
"date": {
|
|
6134
|
+
"description": "date of the usage",
|
|
6135
|
+
"example": "2019-01-01",
|
|
6136
|
+
"format": "date",
|
|
6137
|
+
"readOnly": true,
|
|
6138
|
+
"type": [
|
|
6139
|
+
"string"
|
|
6140
|
+
]
|
|
6141
|
+
},
|
|
6142
|
+
"dynos": {
|
|
6143
|
+
"description": "dynos used",
|
|
6144
|
+
"example": 1.548,
|
|
6145
|
+
"readOnly": true,
|
|
6146
|
+
"type": [
|
|
6147
|
+
"number"
|
|
6148
|
+
]
|
|
6149
|
+
},
|
|
6150
|
+
"id": {
|
|
6151
|
+
"description": "enterprise account identifier",
|
|
6152
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
6153
|
+
"format": "uuid",
|
|
6154
|
+
"readOnly": true,
|
|
6155
|
+
"type": [
|
|
6156
|
+
"string"
|
|
6157
|
+
]
|
|
6158
|
+
},
|
|
6159
|
+
"name": {
|
|
6160
|
+
"description": "name of the enterprise account",
|
|
6161
|
+
"example": "example-co",
|
|
6162
|
+
"readOnly": true,
|
|
6163
|
+
"type": [
|
|
6164
|
+
"string"
|
|
6165
|
+
]
|
|
6166
|
+
},
|
|
6167
|
+
"partner": {
|
|
6168
|
+
"description": "total add-on credits used for third party add-ons",
|
|
6169
|
+
"example": 12.34,
|
|
6170
|
+
"readOnly": true,
|
|
6171
|
+
"type": [
|
|
6172
|
+
"number"
|
|
6173
|
+
]
|
|
6174
|
+
},
|
|
6175
|
+
"space": {
|
|
6176
|
+
"description": "space credits used",
|
|
6177
|
+
"example": 1.548,
|
|
6178
|
+
"readOnly": true,
|
|
6179
|
+
"type": [
|
|
6180
|
+
"number"
|
|
6181
|
+
]
|
|
6182
|
+
},
|
|
6183
|
+
"start_date": {
|
|
6184
|
+
"description": "range start date",
|
|
6185
|
+
"example": "2019-01-25",
|
|
6186
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
6187
|
+
"readOnly": true,
|
|
6188
|
+
"type": [
|
|
6189
|
+
"string"
|
|
6190
|
+
]
|
|
6191
|
+
},
|
|
6192
|
+
"end_date": {
|
|
6193
|
+
"description": "range end date",
|
|
6194
|
+
"example": "2019-02-25",
|
|
6195
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
6196
|
+
"readOnly": true,
|
|
6197
|
+
"type": [
|
|
6198
|
+
"string"
|
|
6199
|
+
]
|
|
6200
|
+
}
|
|
6201
|
+
},
|
|
6202
|
+
"links": [
|
|
6203
|
+
{
|
|
6204
|
+
"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",
|
|
6205
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/daily",
|
|
6206
|
+
"method": "GET",
|
|
6207
|
+
"rel": "instances",
|
|
6208
|
+
"title": "Info",
|
|
6209
|
+
"schema": {
|
|
6210
|
+
"properties": {
|
|
6211
|
+
"start": {
|
|
6212
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/start_date"
|
|
6213
|
+
},
|
|
6214
|
+
"end": {
|
|
6215
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/end_date"
|
|
6216
|
+
}
|
|
6217
|
+
},
|
|
6218
|
+
"required": [
|
|
6219
|
+
"start"
|
|
6220
|
+
],
|
|
6221
|
+
"type": [
|
|
6222
|
+
"object"
|
|
6223
|
+
]
|
|
6224
|
+
},
|
|
6225
|
+
"targetSchema": {
|
|
6226
|
+
"items": {
|
|
6227
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
|
6228
|
+
},
|
|
6229
|
+
"type": [
|
|
6230
|
+
"array"
|
|
6231
|
+
]
|
|
6232
|
+
}
|
|
6233
|
+
}
|
|
6234
|
+
],
|
|
6235
|
+
"properties": {
|
|
6236
|
+
"addons": {
|
|
6237
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/addons"
|
|
6238
|
+
},
|
|
6239
|
+
"teams": {
|
|
6240
|
+
"description": "usage by team",
|
|
6241
|
+
"type": [
|
|
6242
|
+
"array"
|
|
6243
|
+
],
|
|
6244
|
+
"items": {
|
|
6245
|
+
"type": [
|
|
6246
|
+
"object"
|
|
6247
|
+
],
|
|
6248
|
+
"properties": {
|
|
6249
|
+
"addons": {
|
|
6250
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
6251
|
+
},
|
|
6252
|
+
"apps": {
|
|
6253
|
+
"description": "app usage in the team",
|
|
6254
|
+
"type": [
|
|
6255
|
+
"array"
|
|
6256
|
+
],
|
|
6257
|
+
"items": {
|
|
6258
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
|
6259
|
+
}
|
|
6260
|
+
},
|
|
6261
|
+
"data": {
|
|
6262
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
6263
|
+
},
|
|
6264
|
+
"dynos": {
|
|
6265
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
6266
|
+
},
|
|
6267
|
+
"id": {
|
|
6268
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
|
6269
|
+
},
|
|
6270
|
+
"name": {
|
|
6271
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
|
6272
|
+
},
|
|
6273
|
+
"partner": {
|
|
6274
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
6275
|
+
},
|
|
6276
|
+
"space": {
|
|
6277
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
|
6278
|
+
}
|
|
6279
|
+
}
|
|
6280
|
+
}
|
|
6281
|
+
},
|
|
6282
|
+
"data": {
|
|
6283
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/data"
|
|
6284
|
+
},
|
|
6285
|
+
"date": {
|
|
6286
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/date"
|
|
6287
|
+
},
|
|
6288
|
+
"dynos": {
|
|
6289
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/dynos"
|
|
6290
|
+
},
|
|
6291
|
+
"id": {
|
|
6292
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/id"
|
|
6293
|
+
},
|
|
6294
|
+
"name": {
|
|
6295
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/name"
|
|
6296
|
+
},
|
|
6297
|
+
"partner": {
|
|
6298
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/partner"
|
|
6299
|
+
},
|
|
6300
|
+
"space": {
|
|
6301
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/space"
|
|
6302
|
+
}
|
|
6303
|
+
}
|
|
6304
|
+
},
|
|
6305
|
+
"enterprise-account-member": {
|
|
6306
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6307
|
+
"description": "Enterprise account members are users with access to an enterprise account.",
|
|
6308
|
+
"stability": "development",
|
|
6309
|
+
"strictProperties": true,
|
|
6310
|
+
"title": "Heroku Platform API - Enterprise Account Member",
|
|
6311
|
+
"type": [
|
|
6312
|
+
"object"
|
|
6313
|
+
],
|
|
6314
|
+
"definitions": {
|
|
6315
|
+
"id": {
|
|
6316
|
+
"description": "unique identifier of the member",
|
|
6317
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
6190
6318
|
"format": "uuid",
|
|
6191
6319
|
"readOnly": true,
|
|
6192
6320
|
"type": [
|
|
@@ -6427,12 +6555,12 @@
|
|
|
6427
6555
|
}
|
|
6428
6556
|
}
|
|
6429
6557
|
},
|
|
6430
|
-
"enterprise-account-usage
|
|
6558
|
+
"enterprise-account-monthly-usage": {
|
|
6431
6559
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6432
|
-
"description": "Usage for an enterprise account at a
|
|
6560
|
+
"description": "Usage for an enterprise account at a monthly resolution.",
|
|
6433
6561
|
"stability": "development",
|
|
6434
6562
|
"strictProperties": true,
|
|
6435
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
6563
|
+
"title": "Heroku Platform API - Enterprise Account Monthly Usage",
|
|
6436
6564
|
"type": [
|
|
6437
6565
|
"object"
|
|
6438
6566
|
],
|
|
@@ -6445,21 +6573,20 @@
|
|
|
6445
6573
|
"number"
|
|
6446
6574
|
]
|
|
6447
6575
|
},
|
|
6448
|
-
"
|
|
6449
|
-
"description": "
|
|
6450
|
-
"example":
|
|
6576
|
+
"connect": {
|
|
6577
|
+
"description": "average connect rows synced",
|
|
6578
|
+
"example": 15000,
|
|
6451
6579
|
"readOnly": true,
|
|
6452
6580
|
"type": [
|
|
6453
6581
|
"number"
|
|
6454
6582
|
]
|
|
6455
6583
|
},
|
|
6456
|
-
"
|
|
6457
|
-
"description": "
|
|
6458
|
-
"example":
|
|
6459
|
-
"format": "date",
|
|
6584
|
+
"data": {
|
|
6585
|
+
"description": "total add-on credits used for first party add-ons",
|
|
6586
|
+
"example": 34.89,
|
|
6460
6587
|
"readOnly": true,
|
|
6461
6588
|
"type": [
|
|
6462
|
-
"
|
|
6589
|
+
"number"
|
|
6463
6590
|
]
|
|
6464
6591
|
},
|
|
6465
6592
|
"dynos": {
|
|
@@ -6470,6 +6597,15 @@
|
|
|
6470
6597
|
"number"
|
|
6471
6598
|
]
|
|
6472
6599
|
},
|
|
6600
|
+
"month": {
|
|
6601
|
+
"description": "year and month of the usage",
|
|
6602
|
+
"example": "2019-01",
|
|
6603
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
6604
|
+
"readOnly": true,
|
|
6605
|
+
"type": [
|
|
6606
|
+
"string"
|
|
6607
|
+
]
|
|
6608
|
+
},
|
|
6473
6609
|
"id": {
|
|
6474
6610
|
"description": "enterprise account identifier",
|
|
6475
6611
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
@@ -6502,18 +6638,52 @@
|
|
|
6502
6638
|
"type": [
|
|
6503
6639
|
"number"
|
|
6504
6640
|
]
|
|
6641
|
+
},
|
|
6642
|
+
"start_date": {
|
|
6643
|
+
"description": "range start date",
|
|
6644
|
+
"example": "2019-01",
|
|
6645
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
6646
|
+
"readOnly": true,
|
|
6647
|
+
"type": [
|
|
6648
|
+
"string"
|
|
6649
|
+
]
|
|
6650
|
+
},
|
|
6651
|
+
"end_date": {
|
|
6652
|
+
"description": "range end date",
|
|
6653
|
+
"example": "2019-02",
|
|
6654
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
6655
|
+
"readOnly": true,
|
|
6656
|
+
"type": [
|
|
6657
|
+
"string"
|
|
6658
|
+
]
|
|
6505
6659
|
}
|
|
6506
6660
|
},
|
|
6507
6661
|
"links": [
|
|
6508
6662
|
{
|
|
6509
|
-
"description": "Retrieves usage for an enterprise account for a range of
|
|
6510
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/
|
|
6663
|
+
"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",
|
|
6664
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/monthly",
|
|
6511
6665
|
"method": "GET",
|
|
6512
6666
|
"rel": "instances",
|
|
6513
6667
|
"title": "Info",
|
|
6668
|
+
"schema": {
|
|
6669
|
+
"properties": {
|
|
6670
|
+
"start": {
|
|
6671
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/start_date"
|
|
6672
|
+
},
|
|
6673
|
+
"end": {
|
|
6674
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/end_date"
|
|
6675
|
+
}
|
|
6676
|
+
},
|
|
6677
|
+
"required": [
|
|
6678
|
+
"start"
|
|
6679
|
+
],
|
|
6680
|
+
"type": [
|
|
6681
|
+
"object"
|
|
6682
|
+
]
|
|
6683
|
+
},
|
|
6514
6684
|
"targetSchema": {
|
|
6515
6685
|
"items": {
|
|
6516
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6686
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
|
6517
6687
|
},
|
|
6518
6688
|
"type": [
|
|
6519
6689
|
"array"
|
|
@@ -6523,7 +6693,7 @@
|
|
|
6523
6693
|
],
|
|
6524
6694
|
"properties": {
|
|
6525
6695
|
"addons": {
|
|
6526
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6696
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/addons"
|
|
6527
6697
|
},
|
|
6528
6698
|
"teams": {
|
|
6529
6699
|
"description": "usage by team",
|
|
@@ -6536,7 +6706,7 @@
|
|
|
6536
6706
|
],
|
|
6537
6707
|
"properties": {
|
|
6538
6708
|
"addons": {
|
|
6539
|
-
"$ref": "#/definitions/team-usage
|
|
6709
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
6540
6710
|
},
|
|
6541
6711
|
"apps": {
|
|
6542
6712
|
"description": "app usage in the team",
|
|
@@ -6544,257 +6714,85 @@
|
|
|
6544
6714
|
"array"
|
|
6545
6715
|
],
|
|
6546
6716
|
"items": {
|
|
6547
|
-
"$ref": "#/definitions/team-usage
|
|
6717
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
|
6548
6718
|
}
|
|
6549
6719
|
},
|
|
6720
|
+
"connect": {
|
|
6721
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
|
6722
|
+
},
|
|
6550
6723
|
"data": {
|
|
6551
|
-
"$ref": "#/definitions/team-usage
|
|
6724
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
6552
6725
|
},
|
|
6553
6726
|
"dynos": {
|
|
6554
|
-
"$ref": "#/definitions/team-usage
|
|
6727
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
6555
6728
|
},
|
|
6556
6729
|
"id": {
|
|
6557
|
-
"$ref": "#/definitions/team-usage
|
|
6730
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
|
6558
6731
|
},
|
|
6559
6732
|
"name": {
|
|
6560
|
-
"$ref": "#/definitions/team-usage
|
|
6733
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
|
6561
6734
|
},
|
|
6562
6735
|
"partner": {
|
|
6563
|
-
"$ref": "#/definitions/team-usage
|
|
6736
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
6564
6737
|
},
|
|
6565
6738
|
"space": {
|
|
6566
|
-
"$ref": "#/definitions/team-usage
|
|
6739
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
|
6567
6740
|
}
|
|
6568
6741
|
}
|
|
6569
6742
|
}
|
|
6570
6743
|
},
|
|
6571
|
-
"
|
|
6572
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6744
|
+
"connect": {
|
|
6745
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/connect"
|
|
6573
6746
|
},
|
|
6574
|
-
"
|
|
6575
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6747
|
+
"data": {
|
|
6748
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/data"
|
|
6576
6749
|
},
|
|
6577
6750
|
"dynos": {
|
|
6578
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6751
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/dynos"
|
|
6579
6752
|
},
|
|
6580
6753
|
"id": {
|
|
6581
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6754
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/id"
|
|
6755
|
+
},
|
|
6756
|
+
"month": {
|
|
6757
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/month"
|
|
6582
6758
|
},
|
|
6583
6759
|
"name": {
|
|
6584
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6760
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/name"
|
|
6585
6761
|
},
|
|
6586
6762
|
"partner": {
|
|
6587
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6763
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/partner"
|
|
6588
6764
|
},
|
|
6589
6765
|
"space": {
|
|
6590
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
6766
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/space"
|
|
6591
6767
|
}
|
|
6592
6768
|
}
|
|
6593
6769
|
},
|
|
6594
|
-
"enterprise-account
|
|
6770
|
+
"enterprise-account": {
|
|
6595
6771
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6596
|
-
"description": "
|
|
6772
|
+
"description": "Enterprise accounts allow companies to manage their development teams and billing.",
|
|
6597
6773
|
"stability": "development",
|
|
6598
6774
|
"strictProperties": true,
|
|
6599
|
-
"title": "Heroku Platform API - Enterprise Account
|
|
6775
|
+
"title": "Heroku Platform API - Enterprise Account",
|
|
6600
6776
|
"type": [
|
|
6601
6777
|
"object"
|
|
6602
6778
|
],
|
|
6603
6779
|
"definitions": {
|
|
6604
|
-
"
|
|
6605
|
-
"description": "
|
|
6606
|
-
"example":
|
|
6780
|
+
"created_at": {
|
|
6781
|
+
"description": "when the enterprise account was created",
|
|
6782
|
+
"example": "2012-01-01T12:00:00Z",
|
|
6783
|
+
"format": "date-time",
|
|
6607
6784
|
"readOnly": true,
|
|
6608
6785
|
"type": [
|
|
6609
|
-
"
|
|
6786
|
+
"string"
|
|
6610
6787
|
]
|
|
6611
6788
|
},
|
|
6612
|
-
"
|
|
6613
|
-
"description": "
|
|
6614
|
-
"example":
|
|
6789
|
+
"id": {
|
|
6790
|
+
"description": "unique identifier of the enterprise account",
|
|
6791
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
6792
|
+
"format": "uuid",
|
|
6615
6793
|
"readOnly": true,
|
|
6616
6794
|
"type": [
|
|
6617
|
-
"
|
|
6618
|
-
]
|
|
6619
|
-
},
|
|
6620
|
-
"data": {
|
|
6621
|
-
"description": "total add-on credits used for first party add-ons",
|
|
6622
|
-
"example": 34.89,
|
|
6623
|
-
"readOnly": true,
|
|
6624
|
-
"type": [
|
|
6625
|
-
"number"
|
|
6626
|
-
]
|
|
6627
|
-
},
|
|
6628
|
-
"dynos": {
|
|
6629
|
-
"description": "dynos used",
|
|
6630
|
-
"example": 1.548,
|
|
6631
|
-
"readOnly": true,
|
|
6632
|
-
"type": [
|
|
6633
|
-
"number"
|
|
6634
|
-
]
|
|
6635
|
-
},
|
|
6636
|
-
"month": {
|
|
6637
|
-
"description": "year and month of the usage",
|
|
6638
|
-
"example": "2019-01",
|
|
6639
|
-
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
6640
|
-
"readOnly": true,
|
|
6641
|
-
"type": [
|
|
6642
|
-
"string"
|
|
6643
|
-
]
|
|
6644
|
-
},
|
|
6645
|
-
"id": {
|
|
6646
|
-
"description": "enterprise account identifier",
|
|
6647
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
6648
|
-
"format": "uuid",
|
|
6649
|
-
"readOnly": true,
|
|
6650
|
-
"type": [
|
|
6651
|
-
"string"
|
|
6652
|
-
]
|
|
6653
|
-
},
|
|
6654
|
-
"name": {
|
|
6655
|
-
"description": "name of the enterprise account",
|
|
6656
|
-
"example": "example-co",
|
|
6657
|
-
"readOnly": true,
|
|
6658
|
-
"type": [
|
|
6659
|
-
"string"
|
|
6660
|
-
]
|
|
6661
|
-
},
|
|
6662
|
-
"partner": {
|
|
6663
|
-
"description": "total add-on credits used for third party add-ons",
|
|
6664
|
-
"example": 12.34,
|
|
6665
|
-
"readOnly": true,
|
|
6666
|
-
"type": [
|
|
6667
|
-
"number"
|
|
6668
|
-
]
|
|
6669
|
-
},
|
|
6670
|
-
"space": {
|
|
6671
|
-
"description": "space credits used",
|
|
6672
|
-
"example": 1.548,
|
|
6673
|
-
"readOnly": true,
|
|
6674
|
-
"type": [
|
|
6675
|
-
"number"
|
|
6676
|
-
]
|
|
6677
|
-
}
|
|
6678
|
-
},
|
|
6679
|
-
"links": [
|
|
6680
|
-
{
|
|
6681
|
-
"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.",
|
|
6682
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/monthly",
|
|
6683
|
-
"method": "GET",
|
|
6684
|
-
"rel": "instances",
|
|
6685
|
-
"title": "Info",
|
|
6686
|
-
"targetSchema": {
|
|
6687
|
-
"items": {
|
|
6688
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly"
|
|
6689
|
-
},
|
|
6690
|
-
"type": [
|
|
6691
|
-
"array"
|
|
6692
|
-
]
|
|
6693
|
-
}
|
|
6694
|
-
}
|
|
6695
|
-
],
|
|
6696
|
-
"properties": {
|
|
6697
|
-
"addons": {
|
|
6698
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/addons"
|
|
6699
|
-
},
|
|
6700
|
-
"teams": {
|
|
6701
|
-
"description": "usage by team",
|
|
6702
|
-
"type": [
|
|
6703
|
-
"array"
|
|
6704
|
-
],
|
|
6705
|
-
"items": {
|
|
6706
|
-
"type": [
|
|
6707
|
-
"object"
|
|
6708
|
-
],
|
|
6709
|
-
"properties": {
|
|
6710
|
-
"addons": {
|
|
6711
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/addons"
|
|
6712
|
-
},
|
|
6713
|
-
"apps": {
|
|
6714
|
-
"description": "app usage in the team",
|
|
6715
|
-
"type": [
|
|
6716
|
-
"array"
|
|
6717
|
-
],
|
|
6718
|
-
"items": {
|
|
6719
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/app_usage_monthly"
|
|
6720
|
-
}
|
|
6721
|
-
},
|
|
6722
|
-
"connect": {
|
|
6723
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/connect"
|
|
6724
|
-
},
|
|
6725
|
-
"data": {
|
|
6726
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/data"
|
|
6727
|
-
},
|
|
6728
|
-
"dynos": {
|
|
6729
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/dynos"
|
|
6730
|
-
},
|
|
6731
|
-
"id": {
|
|
6732
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/id"
|
|
6733
|
-
},
|
|
6734
|
-
"name": {
|
|
6735
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/name"
|
|
6736
|
-
},
|
|
6737
|
-
"partner": {
|
|
6738
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/partner"
|
|
6739
|
-
},
|
|
6740
|
-
"space": {
|
|
6741
|
-
"$ref": "#/definitions/team-usage-monthly/definitions/space"
|
|
6742
|
-
}
|
|
6743
|
-
}
|
|
6744
|
-
}
|
|
6745
|
-
},
|
|
6746
|
-
"connect": {
|
|
6747
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/connect"
|
|
6748
|
-
},
|
|
6749
|
-
"data": {
|
|
6750
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/data"
|
|
6751
|
-
},
|
|
6752
|
-
"dynos": {
|
|
6753
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/dynos"
|
|
6754
|
-
},
|
|
6755
|
-
"id": {
|
|
6756
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/id"
|
|
6757
|
-
},
|
|
6758
|
-
"month": {
|
|
6759
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/month"
|
|
6760
|
-
},
|
|
6761
|
-
"name": {
|
|
6762
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/name"
|
|
6763
|
-
},
|
|
6764
|
-
"partner": {
|
|
6765
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/partner"
|
|
6766
|
-
},
|
|
6767
|
-
"space": {
|
|
6768
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly/definitions/space"
|
|
6769
|
-
}
|
|
6770
|
-
}
|
|
6771
|
-
},
|
|
6772
|
-
"enterprise-account": {
|
|
6773
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
6774
|
-
"description": "Enterprise accounts allow companies to manage their development teams and billing.",
|
|
6775
|
-
"stability": "development",
|
|
6776
|
-
"strictProperties": true,
|
|
6777
|
-
"title": "Heroku Platform API - Enterprise Account",
|
|
6778
|
-
"type": [
|
|
6779
|
-
"object"
|
|
6780
|
-
],
|
|
6781
|
-
"definitions": {
|
|
6782
|
-
"created_at": {
|
|
6783
|
-
"description": "when the enterprise account was created",
|
|
6784
|
-
"example": "2012-01-01T12:00:00Z",
|
|
6785
|
-
"format": "date-time",
|
|
6786
|
-
"readOnly": true,
|
|
6787
|
-
"type": [
|
|
6788
|
-
"string"
|
|
6789
|
-
]
|
|
6790
|
-
},
|
|
6791
|
-
"id": {
|
|
6792
|
-
"description": "unique identifier of the enterprise account",
|
|
6793
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
6794
|
-
"format": "uuid",
|
|
6795
|
-
"readOnly": true,
|
|
6796
|
-
"type": [
|
|
6797
|
-
"string"
|
|
6795
|
+
"string"
|
|
6798
6796
|
]
|
|
6799
6797
|
},
|
|
6800
6798
|
"identity": {
|
|
@@ -6804,6 +6802,25 @@
|
|
|
6804
6802
|
}
|
|
6805
6803
|
]
|
|
6806
6804
|
},
|
|
6805
|
+
"identity_provider": {
|
|
6806
|
+
"description": "Identity Provider associated with the Enterprise Account",
|
|
6807
|
+
"strictProperties": true,
|
|
6808
|
+
"type": [
|
|
6809
|
+
"null",
|
|
6810
|
+
"object"
|
|
6811
|
+
],
|
|
6812
|
+
"properties": {
|
|
6813
|
+
"id": {
|
|
6814
|
+
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
6815
|
+
},
|
|
6816
|
+
"name": {
|
|
6817
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
6818
|
+
},
|
|
6819
|
+
"owner": {
|
|
6820
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
6821
|
+
}
|
|
6822
|
+
}
|
|
6823
|
+
},
|
|
6807
6824
|
"name": {
|
|
6808
6825
|
"description": "unique name of the enterprise account",
|
|
6809
6826
|
"example": "example",
|
|
@@ -6864,6 +6881,9 @@
|
|
|
6864
6881
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
|
6865
6882
|
"method": "GET",
|
|
6866
6883
|
"rel": "self",
|
|
6884
|
+
"targetSchema": {
|
|
6885
|
+
"$ref": "#/definitions/enterprise-account"
|
|
6886
|
+
},
|
|
6867
6887
|
"title": "Info"
|
|
6868
6888
|
},
|
|
6869
6889
|
{
|
|
@@ -6906,27 +6926,7 @@
|
|
|
6906
6926
|
"$ref": "#/definitions/enterprise-account/definitions/trial"
|
|
6907
6927
|
},
|
|
6908
6928
|
"identity_provider": {
|
|
6909
|
-
"
|
|
6910
|
-
"strictProperties": true,
|
|
6911
|
-
"type": [
|
|
6912
|
-
"null",
|
|
6913
|
-
"object"
|
|
6914
|
-
],
|
|
6915
|
-
"properties": {
|
|
6916
|
-
"id": {
|
|
6917
|
-
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
6918
|
-
},
|
|
6919
|
-
"name": {
|
|
6920
|
-
"description": "user-friendly unique identifier for this identity provider",
|
|
6921
|
-
"example": "acme-sso",
|
|
6922
|
-
"type": [
|
|
6923
|
-
"string"
|
|
6924
|
-
]
|
|
6925
|
-
},
|
|
6926
|
-
"owner": {
|
|
6927
|
-
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
6928
|
-
}
|
|
6929
|
-
}
|
|
6929
|
+
"$ref": "#/definitions/enterprise-account/definitions/identity_provider"
|
|
6930
6930
|
}
|
|
6931
6931
|
}
|
|
6932
6932
|
},
|
|
@@ -7223,7 +7223,7 @@
|
|
|
7223
7223
|
}
|
|
7224
7224
|
},
|
|
7225
7225
|
"identity-provider": {
|
|
7226
|
-
"description": "Identity Providers represent the SAML configuration of an Team.",
|
|
7226
|
+
"description": "Identity Providers represent the SAML configuration of an Enterprise Account or Team.",
|
|
7227
7227
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7228
7228
|
"stability": "production",
|
|
7229
7229
|
"strictProperties": true,
|
|
@@ -7266,6 +7266,13 @@
|
|
|
7266
7266
|
"string"
|
|
7267
7267
|
]
|
|
7268
7268
|
},
|
|
7269
|
+
"name": {
|
|
7270
|
+
"description": "user-friendly unique identifier for this identity provider",
|
|
7271
|
+
"example": "acme-sso",
|
|
7272
|
+
"type": [
|
|
7273
|
+
"string"
|
|
7274
|
+
]
|
|
7275
|
+
},
|
|
7269
7276
|
"slo_target_url": {
|
|
7270
7277
|
"description": "single log out URL for this identity provider",
|
|
7271
7278
|
"example": "https://example.com/idp/logout",
|
|
@@ -7719,6 +7726,9 @@
|
|
|
7719
7726
|
"href": "/account/invoice-address",
|
|
7720
7727
|
"method": "GET",
|
|
7721
7728
|
"rel": "self",
|
|
7729
|
+
"targetSchema": {
|
|
7730
|
+
"$ref": "#/definitions/invoice-address"
|
|
7731
|
+
},
|
|
7722
7732
|
"title": "info"
|
|
7723
7733
|
},
|
|
7724
7734
|
{
|
|
@@ -7757,6 +7767,9 @@
|
|
|
7757
7767
|
"type": [
|
|
7758
7768
|
"object"
|
|
7759
7769
|
]
|
|
7770
|
+
},
|
|
7771
|
+
"targetSchema": {
|
|
7772
|
+
"$ref": "#/definitions/invoice-address"
|
|
7760
7773
|
}
|
|
7761
7774
|
}
|
|
7762
7775
|
],
|
|
@@ -8097,7 +8110,11 @@
|
|
|
8097
8110
|
"description": "add-on that created the drain",
|
|
8098
8111
|
"example": {
|
|
8099
8112
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
8100
|
-
"name": "singing-swiftly-1242"
|
|
8113
|
+
"name": "singing-swiftly-1242",
|
|
8114
|
+
"app": {
|
|
8115
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
8116
|
+
"name": "example"
|
|
8117
|
+
}
|
|
8101
8118
|
},
|
|
8102
8119
|
"properties": {
|
|
8103
8120
|
"id": {
|
|
@@ -8105,8 +8122,44 @@
|
|
|
8105
8122
|
},
|
|
8106
8123
|
"name": {
|
|
8107
8124
|
"$ref": "#/definitions/add-on/definitions/name"
|
|
8125
|
+
},
|
|
8126
|
+
"app": {
|
|
8127
|
+
"description": "billing application associated with this add-on",
|
|
8128
|
+
"type": [
|
|
8129
|
+
"object"
|
|
8130
|
+
],
|
|
8131
|
+
"properties": {
|
|
8132
|
+
"id": {
|
|
8133
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
8134
|
+
},
|
|
8135
|
+
"name": {
|
|
8136
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
8137
|
+
}
|
|
8138
|
+
},
|
|
8139
|
+
"strictProperties": true
|
|
8140
|
+
}
|
|
8141
|
+
},
|
|
8142
|
+
"readOnly": true,
|
|
8143
|
+
"type": [
|
|
8144
|
+
"object",
|
|
8145
|
+
"null"
|
|
8146
|
+
]
|
|
8147
|
+
},
|
|
8148
|
+
"app": {
|
|
8149
|
+
"description": "application that is attached to this drain",
|
|
8150
|
+
"example": {
|
|
8151
|
+
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
8152
|
+
"name": "example"
|
|
8153
|
+
},
|
|
8154
|
+
"properties": {
|
|
8155
|
+
"id": {
|
|
8156
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
8157
|
+
},
|
|
8158
|
+
"name": {
|
|
8159
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
8108
8160
|
}
|
|
8109
8161
|
},
|
|
8162
|
+
"strictProperties": true,
|
|
8110
8163
|
"readOnly": true,
|
|
8111
8164
|
"type": [
|
|
8112
8165
|
"object",
|
|
@@ -8279,6 +8332,9 @@
|
|
|
8279
8332
|
"addon": {
|
|
8280
8333
|
"$ref": "#/definitions/log-drain/definitions/addon"
|
|
8281
8334
|
},
|
|
8335
|
+
"app": {
|
|
8336
|
+
"$ref": "#/definitions/log-drain/definitions/app"
|
|
8337
|
+
},
|
|
8282
8338
|
"created_at": {
|
|
8283
8339
|
"$ref": "#/definitions/log-drain/definitions/created_at"
|
|
8284
8340
|
},
|
|
@@ -9410,10 +9466,16 @@
|
|
|
9410
9466
|
"$ref": "#/definitions/account/definitions/email"
|
|
9411
9467
|
}
|
|
9412
9468
|
},
|
|
9469
|
+
"required": [
|
|
9470
|
+
"email"
|
|
9471
|
+
],
|
|
9413
9472
|
"type": [
|
|
9414
9473
|
"object"
|
|
9415
9474
|
]
|
|
9416
9475
|
},
|
|
9476
|
+
"targetSchema": {
|
|
9477
|
+
"$ref": "#/definitions/password-reset"
|
|
9478
|
+
},
|
|
9417
9479
|
"title": "Reset Password"
|
|
9418
9480
|
},
|
|
9419
9481
|
{
|
|
@@ -9430,10 +9492,17 @@
|
|
|
9430
9492
|
"$ref": "#/definitions/password-reset/definitions/password_confirmation"
|
|
9431
9493
|
}
|
|
9432
9494
|
},
|
|
9495
|
+
"required": [
|
|
9496
|
+
"password",
|
|
9497
|
+
"password_confirmation"
|
|
9498
|
+
],
|
|
9433
9499
|
"type": [
|
|
9434
9500
|
"object"
|
|
9435
9501
|
]
|
|
9436
9502
|
},
|
|
9503
|
+
"targetSchema": {
|
|
9504
|
+
"$ref": "#/definitions/password-reset"
|
|
9505
|
+
},
|
|
9437
9506
|
"title": "Complete Reset Password"
|
|
9438
9507
|
}
|
|
9439
9508
|
],
|
|
@@ -9663,14 +9732,20 @@
|
|
|
9663
9732
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}/actions/accept",
|
|
9664
9733
|
"method": "POST",
|
|
9665
9734
|
"rel": "empty",
|
|
9666
|
-
"title": "Accept"
|
|
9667
|
-
|
|
9735
|
+
"title": "Accept",
|
|
9736
|
+
"targetSchema": {
|
|
9737
|
+
"$ref": "#/definitions/peering"
|
|
9738
|
+
}
|
|
9739
|
+
},
|
|
9668
9740
|
{
|
|
9669
9741
|
"description": "Destroy an active peering connection with a private space.",
|
|
9670
9742
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
|
|
9671
9743
|
"rel": "empty",
|
|
9672
9744
|
"method": "DELETE",
|
|
9673
|
-
"title": "Destroy"
|
|
9745
|
+
"title": "Destroy",
|
|
9746
|
+
"targetSchema": {
|
|
9747
|
+
"$ref": "#/definitions/peering"
|
|
9748
|
+
}
|
|
9674
9749
|
},
|
|
9675
9750
|
{
|
|
9676
9751
|
"description": "Fetch information for existing peering connection",
|
|
@@ -9808,7 +9883,7 @@
|
|
|
9808
9883
|
"links": [
|
|
9809
9884
|
{
|
|
9810
9885
|
"description": "List latest builds for each app in a pipeline",
|
|
9811
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
9886
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-builds",
|
|
9812
9887
|
"method": "GET",
|
|
9813
9888
|
"rel": "instances",
|
|
9814
9889
|
"targetSchema": {
|
|
@@ -10158,7 +10233,7 @@
|
|
|
10158
10233
|
"links": [
|
|
10159
10234
|
{
|
|
10160
10235
|
"description": "List latest slug releases for each app in a pipeline",
|
|
10161
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
10236
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-deployments",
|
|
10162
10237
|
"method": "GET",
|
|
10163
10238
|
"rel": "instances",
|
|
10164
10239
|
"targetSchema": {
|
|
@@ -10507,7 +10582,7 @@
|
|
|
10507
10582
|
"links": [
|
|
10508
10583
|
{
|
|
10509
10584
|
"description": "List latest releases for each app in a pipeline",
|
|
10510
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
10585
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-releases",
|
|
10511
10586
|
"method": "GET",
|
|
10512
10587
|
"rel": "instances",
|
|
10513
10588
|
"targetSchema": {
|
|
@@ -10534,7 +10609,7 @@
|
|
|
10534
10609
|
"links": [
|
|
10535
10610
|
{
|
|
10536
10611
|
"description": "The stack for a given pipeline, used for CI and Review Apps that have no stack defined in app.json.",
|
|
10537
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
|
10612
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/pipeline-stack",
|
|
10538
10613
|
"method": "GET",
|
|
10539
10614
|
"rel": "self",
|
|
10540
10615
|
"targetSchema": {
|
|
@@ -10843,11 +10918,11 @@
|
|
|
10843
10918
|
"targetSchema": {
|
|
10844
10919
|
"items": {
|
|
10845
10920
|
"$ref": "#/definitions/pipeline"
|
|
10846
|
-
}
|
|
10921
|
+
},
|
|
10922
|
+
"type": [
|
|
10923
|
+
"array"
|
|
10924
|
+
]
|
|
10847
10925
|
},
|
|
10848
|
-
"type": [
|
|
10849
|
-
"array"
|
|
10850
|
-
],
|
|
10851
10926
|
"title": "List"
|
|
10852
10927
|
}
|
|
10853
10928
|
],
|
|
@@ -11295,12 +11370,14 @@
|
|
|
11295
11370
|
"ap-southeast-1",
|
|
11296
11371
|
"ap-southeast-2",
|
|
11297
11372
|
"eu-central-1",
|
|
11373
|
+
"eu-west-2",
|
|
11298
11374
|
"ap-northeast-2",
|
|
11299
11375
|
"ap-northeast-1",
|
|
11300
11376
|
"us-east-1",
|
|
11301
11377
|
"sa-east-1",
|
|
11302
11378
|
"us-west-1",
|
|
11303
|
-
"us-west-2"
|
|
11379
|
+
"us-west-2",
|
|
11380
|
+
"ca-central-1"
|
|
11304
11381
|
]
|
|
11305
11382
|
}
|
|
11306
11383
|
},
|
|
@@ -12545,6 +12622,18 @@
|
|
|
12545
12622
|
"object"
|
|
12546
12623
|
],
|
|
12547
12624
|
"definitions": {
|
|
12625
|
+
"ca_signed?": {
|
|
12626
|
+
"readOnly": true,
|
|
12627
|
+
"type": [
|
|
12628
|
+
"boolean"
|
|
12629
|
+
]
|
|
12630
|
+
},
|
|
12631
|
+
"cert_domains": {
|
|
12632
|
+
"readOnly": true,
|
|
12633
|
+
"type": [
|
|
12634
|
+
"array"
|
|
12635
|
+
]
|
|
12636
|
+
},
|
|
12548
12637
|
"certificate_chain": {
|
|
12549
12638
|
"description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
|
|
12550
12639
|
"example": "-----BEGIN CERTIFICATE----- ...",
|
|
@@ -12553,20 +12642,38 @@
|
|
|
12553
12642
|
"string"
|
|
12554
12643
|
]
|
|
12555
12644
|
},
|
|
12556
|
-
"
|
|
12557
|
-
"description": "
|
|
12558
|
-
"example": "
|
|
12645
|
+
"created_at": {
|
|
12646
|
+
"description": "when endpoint was created",
|
|
12647
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12648
|
+
"format": "date-time",
|
|
12649
|
+
"readOnly": true,
|
|
12650
|
+
"type": [
|
|
12651
|
+
"string"
|
|
12652
|
+
]
|
|
12653
|
+
},
|
|
12654
|
+
"domains": {
|
|
12655
|
+
"description": "domains associated with this SSL certificate",
|
|
12656
|
+
"type": [
|
|
12657
|
+
"array"
|
|
12658
|
+
],
|
|
12659
|
+
"readOnly": true,
|
|
12660
|
+
"items": {
|
|
12661
|
+
"$ref": "#/definitions/domain/definitions/id"
|
|
12662
|
+
}
|
|
12663
|
+
},
|
|
12664
|
+
"display_name": {
|
|
12665
|
+
"description": "unique name for SSL certificate",
|
|
12666
|
+
"example": "example",
|
|
12667
|
+
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
12559
12668
|
"readOnly": false,
|
|
12560
12669
|
"type": [
|
|
12561
12670
|
"string",
|
|
12562
12671
|
"null"
|
|
12563
12672
|
]
|
|
12564
12673
|
},
|
|
12565
|
-
"
|
|
12566
|
-
"description": "when endpoint was created",
|
|
12567
|
-
"example": "2012-01-01T12:00:00Z",
|
|
12568
|
-
"format": "date-time",
|
|
12674
|
+
"expires_at": {
|
|
12569
12675
|
"readOnly": true,
|
|
12676
|
+
"format": "date-time",
|
|
12570
12677
|
"type": [
|
|
12571
12678
|
"string"
|
|
12572
12679
|
]
|
|
@@ -12590,6 +12697,12 @@
|
|
|
12590
12697
|
}
|
|
12591
12698
|
]
|
|
12592
12699
|
},
|
|
12700
|
+
"issuer": {
|
|
12701
|
+
"readOnly": true,
|
|
12702
|
+
"type": [
|
|
12703
|
+
"string"
|
|
12704
|
+
]
|
|
12705
|
+
},
|
|
12593
12706
|
"name": {
|
|
12594
12707
|
"description": "unique name for SNI endpoint",
|
|
12595
12708
|
"example": "example",
|
|
@@ -12607,33 +12720,32 @@
|
|
|
12607
12720
|
"string"
|
|
12608
12721
|
]
|
|
12609
12722
|
},
|
|
12610
|
-
"
|
|
12611
|
-
"description": "when SNI endpoint was updated",
|
|
12612
|
-
"example": "2012-01-01T12:00:00Z",
|
|
12613
|
-
"format": "date-time",
|
|
12723
|
+
"self_signed?": {
|
|
12614
12724
|
"readOnly": true,
|
|
12615
12725
|
"type": [
|
|
12616
|
-
"
|
|
12726
|
+
"boolean"
|
|
12617
12727
|
]
|
|
12618
12728
|
},
|
|
12619
|
-
"
|
|
12620
|
-
"
|
|
12729
|
+
"starts_at": {
|
|
12730
|
+
"readOnly": true,
|
|
12731
|
+
"format": "date-time",
|
|
12621
12732
|
"type": [
|
|
12622
|
-
"
|
|
12623
|
-
]
|
|
12733
|
+
"string"
|
|
12734
|
+
]
|
|
12735
|
+
},
|
|
12736
|
+
"subject": {
|
|
12624
12737
|
"readOnly": true,
|
|
12625
|
-
"
|
|
12626
|
-
"
|
|
12627
|
-
|
|
12738
|
+
"type": [
|
|
12739
|
+
"string"
|
|
12740
|
+
]
|
|
12628
12741
|
},
|
|
12629
|
-
"
|
|
12630
|
-
"description": "
|
|
12631
|
-
"example": "
|
|
12632
|
-
"
|
|
12633
|
-
"readOnly":
|
|
12742
|
+
"updated_at": {
|
|
12743
|
+
"description": "when SNI endpoint was updated",
|
|
12744
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12745
|
+
"format": "date-time",
|
|
12746
|
+
"readOnly": true,
|
|
12634
12747
|
"type": [
|
|
12635
|
-
"string"
|
|
12636
|
-
"null"
|
|
12748
|
+
"string"
|
|
12637
12749
|
]
|
|
12638
12750
|
}
|
|
12639
12751
|
},
|
|
@@ -12732,9 +12844,6 @@
|
|
|
12732
12844
|
"certificate_chain": {
|
|
12733
12845
|
"$ref": "#/definitions/sni-endpoint/definitions/certificate_chain"
|
|
12734
12846
|
},
|
|
12735
|
-
"cname": {
|
|
12736
|
-
"$ref": "#/definitions/sni-endpoint/definitions/cname"
|
|
12737
|
-
},
|
|
12738
12847
|
"created_at": {
|
|
12739
12848
|
"$ref": "#/definitions/sni-endpoint/definitions/created_at"
|
|
12740
12849
|
},
|
|
@@ -12775,25 +12884,25 @@
|
|
|
12775
12884
|
],
|
|
12776
12885
|
"properties": {
|
|
12777
12886
|
"ca_signed?": {
|
|
12778
|
-
"$ref": "#/definitions/
|
|
12887
|
+
"$ref": "#/definitions/sni-endpoint/definitions/ca_signed?"
|
|
12779
12888
|
},
|
|
12780
12889
|
"cert_domains": {
|
|
12781
|
-
"$ref": "#/definitions/
|
|
12890
|
+
"$ref": "#/definitions/sni-endpoint/definitions/cert_domains"
|
|
12782
12891
|
},
|
|
12783
12892
|
"expires_at": {
|
|
12784
|
-
"$ref": "#/definitions/
|
|
12893
|
+
"$ref": "#/definitions/sni-endpoint/definitions/expires_at"
|
|
12785
12894
|
},
|
|
12786
12895
|
"issuer": {
|
|
12787
|
-
"$ref": "#/definitions/
|
|
12896
|
+
"$ref": "#/definitions/sni-endpoint/definitions/issuer"
|
|
12788
12897
|
},
|
|
12789
12898
|
"self_signed?": {
|
|
12790
|
-
"$ref": "#/definitions/
|
|
12899
|
+
"$ref": "#/definitions/sni-endpoint/definitions/self_signed?"
|
|
12791
12900
|
},
|
|
12792
12901
|
"starts_at": {
|
|
12793
|
-
"$ref": "#/definitions/
|
|
12902
|
+
"$ref": "#/definitions/sni-endpoint/definitions/starts_at"
|
|
12794
12903
|
},
|
|
12795
12904
|
"subject": {
|
|
12796
|
-
"$ref": "#/definitions/
|
|
12905
|
+
"$ref": "#/definitions/sni-endpoint/definitions/subject"
|
|
12797
12906
|
},
|
|
12798
12907
|
"id": {
|
|
12799
12908
|
"description": "unique identifier of this SSL certificate",
|
|
@@ -13288,7 +13397,7 @@
|
|
|
13288
13397
|
]
|
|
13289
13398
|
},
|
|
13290
13399
|
"space": {
|
|
13291
|
-
"description": "A space is an isolated, highly available, secure app execution
|
|
13400
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
|
13292
13401
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13293
13402
|
"stability": "prototype",
|
|
13294
13403
|
"strictProperties": true,
|
|
@@ -13364,6 +13473,13 @@
|
|
|
13364
13473
|
"string"
|
|
13365
13474
|
]
|
|
13366
13475
|
},
|
|
13476
|
+
"log_drain_url": {
|
|
13477
|
+
"description": "URL to which all apps will drain logs. Only settable during space creation and enables direct logging. Must use HTTPS.",
|
|
13478
|
+
"example": "https://example.com/logs",
|
|
13479
|
+
"type": [
|
|
13480
|
+
"string"
|
|
13481
|
+
]
|
|
13482
|
+
},
|
|
13367
13483
|
"cidr": {
|
|
13368
13484
|
"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",
|
|
13369
13485
|
"example": "172.20.20.30/16",
|
|
@@ -13463,6 +13579,9 @@
|
|
|
13463
13579
|
},
|
|
13464
13580
|
"data_cidr": {
|
|
13465
13581
|
"$ref": "#/definitions/space/definitions/data_cidr"
|
|
13582
|
+
},
|
|
13583
|
+
"log_drain_url": {
|
|
13584
|
+
"$ref": "#/definitions/space/definitions/log_drain_url"
|
|
13466
13585
|
}
|
|
13467
13586
|
},
|
|
13468
13587
|
"required": [
|
|
@@ -13546,52 +13665,18 @@
|
|
|
13546
13665
|
}
|
|
13547
13666
|
}
|
|
13548
13667
|
},
|
|
13549
|
-
"
|
|
13550
|
-
"description": "
|
|
13668
|
+
"stack": {
|
|
13669
|
+
"description": "Stacks are the different application execution environments available in the Heroku platform.",
|
|
13551
13670
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13552
|
-
"title": "Heroku Platform API - SSL Endpoint",
|
|
13553
13671
|
"stability": "production",
|
|
13554
13672
|
"strictProperties": true,
|
|
13673
|
+
"title": "Heroku Platform API - Stack",
|
|
13555
13674
|
"type": [
|
|
13556
13675
|
"object"
|
|
13557
13676
|
],
|
|
13558
13677
|
"definitions": {
|
|
13559
|
-
"acm": {
|
|
13560
|
-
"readOnly": true,
|
|
13561
|
-
"type": [
|
|
13562
|
-
"boolean"
|
|
13563
|
-
]
|
|
13564
|
-
},
|
|
13565
|
-
"ca_signed?": {
|
|
13566
|
-
"readOnly": true,
|
|
13567
|
-
"type": [
|
|
13568
|
-
"boolean"
|
|
13569
|
-
]
|
|
13570
|
-
},
|
|
13571
|
-
"cert_domains": {
|
|
13572
|
-
"readOnly": true,
|
|
13573
|
-
"type": [
|
|
13574
|
-
"array"
|
|
13575
|
-
]
|
|
13576
|
-
},
|
|
13577
|
-
"certificate_chain": {
|
|
13578
|
-
"description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
|
|
13579
|
-
"example": "-----BEGIN CERTIFICATE----- ...",
|
|
13580
|
-
"readOnly": false,
|
|
13581
|
-
"type": [
|
|
13582
|
-
"string"
|
|
13583
|
-
]
|
|
13584
|
-
},
|
|
13585
|
-
"cname": {
|
|
13586
|
-
"description": "canonical name record, the address to point a domain at",
|
|
13587
|
-
"example": "example.herokussl.com",
|
|
13588
|
-
"readOnly": false,
|
|
13589
|
-
"type": [
|
|
13590
|
-
"string"
|
|
13591
|
-
]
|
|
13592
|
-
},
|
|
13593
13678
|
"created_at": {
|
|
13594
|
-
"description": "when
|
|
13679
|
+
"description": "when stack was introduced",
|
|
13595
13680
|
"example": "2012-01-01T12:00:00Z",
|
|
13596
13681
|
"format": "date-time",
|
|
13597
13682
|
"readOnly": true,
|
|
@@ -13599,25 +13684,16 @@
|
|
|
13599
13684
|
"string"
|
|
13600
13685
|
]
|
|
13601
13686
|
},
|
|
13602
|
-
"
|
|
13603
|
-
"description": "
|
|
13604
|
-
"example":
|
|
13605
|
-
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
13606
|
-
"readOnly": false,
|
|
13607
|
-
"type": [
|
|
13608
|
-
"string",
|
|
13609
|
-
"null"
|
|
13610
|
-
]
|
|
13611
|
-
},
|
|
13612
|
-
"expires_at": {
|
|
13687
|
+
"default": {
|
|
13688
|
+
"description": "indicates this stack is the default for new apps",
|
|
13689
|
+
"example": true,
|
|
13613
13690
|
"readOnly": true,
|
|
13614
|
-
"format": "date-time",
|
|
13615
13691
|
"type": [
|
|
13616
|
-
"
|
|
13692
|
+
"boolean"
|
|
13617
13693
|
]
|
|
13618
13694
|
},
|
|
13619
13695
|
"id": {
|
|
13620
|
-
"description": "unique identifier of
|
|
13696
|
+
"description": "unique identifier of stack",
|
|
13621
13697
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13622
13698
|
"format": "uuid",
|
|
13623
13699
|
"readOnly": true,
|
|
@@ -13628,66 +13704,31 @@
|
|
|
13628
13704
|
"identity": {
|
|
13629
13705
|
"anyOf": [
|
|
13630
13706
|
{
|
|
13631
|
-
"$ref": "#/definitions/
|
|
13707
|
+
"$ref": "#/definitions/stack/definitions/name"
|
|
13632
13708
|
},
|
|
13633
13709
|
{
|
|
13634
|
-
"$ref": "#/definitions/
|
|
13710
|
+
"$ref": "#/definitions/stack/definitions/id"
|
|
13635
13711
|
}
|
|
13636
13712
|
]
|
|
13637
13713
|
},
|
|
13638
|
-
"issuer": {
|
|
13639
|
-
"readOnly": true,
|
|
13640
|
-
"type": [
|
|
13641
|
-
"string"
|
|
13642
|
-
]
|
|
13643
|
-
},
|
|
13644
13714
|
"name": {
|
|
13645
|
-
"description": "unique name
|
|
13646
|
-
"example": "
|
|
13647
|
-
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
|
13648
|
-
"readOnly": true,
|
|
13649
|
-
"type": [
|
|
13650
|
-
"string"
|
|
13651
|
-
]
|
|
13652
|
-
},
|
|
13653
|
-
"preprocess": {
|
|
13654
|
-
"default": true,
|
|
13655
|
-
"description": "allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.",
|
|
13656
|
-
"example": true,
|
|
13657
|
-
"readOnly": false,
|
|
13658
|
-
"type": [
|
|
13659
|
-
"boolean"
|
|
13660
|
-
]
|
|
13661
|
-
},
|
|
13662
|
-
"private_key": {
|
|
13663
|
-
"description": "contents of the private key (eg .key file)",
|
|
13664
|
-
"example": "-----BEGIN RSA PRIVATE KEY----- ...",
|
|
13665
|
-
"readOnly": false,
|
|
13666
|
-
"type": [
|
|
13667
|
-
"string"
|
|
13668
|
-
]
|
|
13669
|
-
},
|
|
13670
|
-
"self_signed?": {
|
|
13671
|
-
"readOnly": true,
|
|
13672
|
-
"type": [
|
|
13673
|
-
"boolean"
|
|
13674
|
-
]
|
|
13675
|
-
},
|
|
13676
|
-
"starts_at": {
|
|
13715
|
+
"description": "unique name of stack",
|
|
13716
|
+
"example": "heroku-18",
|
|
13677
13717
|
"readOnly": true,
|
|
13678
|
-
"format": "date-time",
|
|
13679
13718
|
"type": [
|
|
13680
13719
|
"string"
|
|
13681
13720
|
]
|
|
13682
13721
|
},
|
|
13683
|
-
"
|
|
13722
|
+
"state": {
|
|
13723
|
+
"description": "availability of this stack: beta, deprecated or public",
|
|
13724
|
+
"example": "public",
|
|
13684
13725
|
"readOnly": true,
|
|
13685
13726
|
"type": [
|
|
13686
13727
|
"string"
|
|
13687
13728
|
]
|
|
13688
13729
|
},
|
|
13689
13730
|
"updated_at": {
|
|
13690
|
-
"description": "when
|
|
13731
|
+
"description": "when stack was last modified",
|
|
13691
13732
|
"example": "2012-01-01T12:00:00Z",
|
|
13692
13733
|
"format": "date-time",
|
|
13693
13734
|
"readOnly": true,
|
|
@@ -13698,285 +13739,34 @@
|
|
|
13698
13739
|
},
|
|
13699
13740
|
"links": [
|
|
13700
13741
|
{
|
|
13701
|
-
"description": "
|
|
13702
|
-
"href": "/
|
|
13703
|
-
"method": "POST",
|
|
13704
|
-
"rel": "create",
|
|
13705
|
-
"schema": {
|
|
13706
|
-
"properties": {
|
|
13707
|
-
"certificate_chain": {
|
|
13708
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
13709
|
-
},
|
|
13710
|
-
"preprocess": {
|
|
13711
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/preprocess"
|
|
13712
|
-
},
|
|
13713
|
-
"private_key": {
|
|
13714
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/private_key"
|
|
13715
|
-
}
|
|
13716
|
-
},
|
|
13717
|
-
"required": [
|
|
13718
|
-
"certificate_chain",
|
|
13719
|
-
"private_key"
|
|
13720
|
-
],
|
|
13721
|
-
"type": [
|
|
13722
|
-
"object"
|
|
13723
|
-
]
|
|
13724
|
-
},
|
|
13725
|
-
"targetSchema": {
|
|
13726
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
13727
|
-
},
|
|
13728
|
-
"title": "Create"
|
|
13729
|
-
},
|
|
13730
|
-
{
|
|
13731
|
-
"description": "Delete existing SSL endpoint.",
|
|
13732
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}",
|
|
13733
|
-
"method": "DELETE",
|
|
13734
|
-
"rel": "destroy",
|
|
13735
|
-
"targetSchema": {
|
|
13736
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
13737
|
-
},
|
|
13738
|
-
"title": "Delete"
|
|
13739
|
-
},
|
|
13740
|
-
{
|
|
13741
|
-
"description": "Info for existing SSL endpoint.",
|
|
13742
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}",
|
|
13742
|
+
"description": "Stack info.",
|
|
13743
|
+
"href": "/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
|
|
13743
13744
|
"method": "GET",
|
|
13744
13745
|
"rel": "self",
|
|
13745
13746
|
"targetSchema": {
|
|
13746
|
-
"$ref": "#/definitions/
|
|
13747
|
+
"$ref": "#/definitions/stack"
|
|
13747
13748
|
},
|
|
13748
13749
|
"title": "Info"
|
|
13749
13750
|
},
|
|
13750
13751
|
{
|
|
13751
|
-
"description": "List
|
|
13752
|
-
"href": "/
|
|
13752
|
+
"description": "List available stacks.",
|
|
13753
|
+
"href": "/stacks",
|
|
13753
13754
|
"method": "GET",
|
|
13754
13755
|
"rel": "instances",
|
|
13755
13756
|
"targetSchema": {
|
|
13756
13757
|
"items": {
|
|
13757
|
-
"$ref": "#/definitions/
|
|
13758
|
+
"$ref": "#/definitions/stack"
|
|
13758
13759
|
},
|
|
13759
13760
|
"type": [
|
|
13760
13761
|
"array"
|
|
13761
13762
|
]
|
|
13762
13763
|
},
|
|
13763
13764
|
"title": "List"
|
|
13764
|
-
}
|
|
13765
|
-
|
|
13766
|
-
|
|
13767
|
-
|
|
13768
|
-
"
|
|
13769
|
-
"rel": "update",
|
|
13770
|
-
"schema": {
|
|
13771
|
-
"properties": {
|
|
13772
|
-
"certificate_chain": {
|
|
13773
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
13774
|
-
},
|
|
13775
|
-
"preprocess": {
|
|
13776
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/preprocess"
|
|
13777
|
-
},
|
|
13778
|
-
"private_key": {
|
|
13779
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/private_key"
|
|
13780
|
-
}
|
|
13781
|
-
},
|
|
13782
|
-
"type": [
|
|
13783
|
-
"object"
|
|
13784
|
-
]
|
|
13785
|
-
},
|
|
13786
|
-
"targetSchema": {
|
|
13787
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
13788
|
-
},
|
|
13789
|
-
"title": "Update"
|
|
13790
|
-
}
|
|
13791
|
-
],
|
|
13792
|
-
"properties": {
|
|
13793
|
-
"app": {
|
|
13794
|
-
"description": "application associated with this ssl-endpoint",
|
|
13795
|
-
"type": [
|
|
13796
|
-
"object"
|
|
13797
|
-
],
|
|
13798
|
-
"properties": {
|
|
13799
|
-
"id": {
|
|
13800
|
-
"$ref": "#/definitions/app/definitions/id"
|
|
13801
|
-
},
|
|
13802
|
-
"name": {
|
|
13803
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
13804
|
-
}
|
|
13805
|
-
},
|
|
13806
|
-
"strictProperties": true
|
|
13807
|
-
},
|
|
13808
|
-
"certificate_chain": {
|
|
13809
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/certificate_chain"
|
|
13810
|
-
},
|
|
13811
|
-
"cname": {
|
|
13812
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/cname"
|
|
13813
|
-
},
|
|
13814
|
-
"created_at": {
|
|
13815
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/created_at"
|
|
13816
|
-
},
|
|
13817
|
-
"display_name": {
|
|
13818
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/display_name"
|
|
13819
|
-
},
|
|
13820
|
-
"domains": {
|
|
13821
|
-
"description": "domains associated with this endpoint",
|
|
13822
|
-
"type": [
|
|
13823
|
-
"array"
|
|
13824
|
-
],
|
|
13825
|
-
"items": {
|
|
13826
|
-
"$ref": "#/definitions/domain/definitions/id"
|
|
13827
|
-
}
|
|
13828
|
-
},
|
|
13829
|
-
"id": {
|
|
13830
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/id"
|
|
13831
|
-
},
|
|
13832
|
-
"name": {
|
|
13833
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/name"
|
|
13834
|
-
},
|
|
13835
|
-
"ssl_cert": {
|
|
13836
|
-
"description": "certificate provided by this endpoint",
|
|
13837
|
-
"type": [
|
|
13838
|
-
"object"
|
|
13839
|
-
],
|
|
13840
|
-
"properties": {
|
|
13841
|
-
"ca_signed?": {
|
|
13842
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/ca_signed?"
|
|
13843
|
-
},
|
|
13844
|
-
"cert_domains": {
|
|
13845
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/cert_domains"
|
|
13846
|
-
},
|
|
13847
|
-
"expires_at": {
|
|
13848
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/expires_at"
|
|
13849
|
-
},
|
|
13850
|
-
"issuer": {
|
|
13851
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/issuer"
|
|
13852
|
-
},
|
|
13853
|
-
"self_signed?": {
|
|
13854
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/self_signed?"
|
|
13855
|
-
},
|
|
13856
|
-
"starts_at": {
|
|
13857
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/starts_at"
|
|
13858
|
-
},
|
|
13859
|
-
"subject": {
|
|
13860
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/subject"
|
|
13861
|
-
},
|
|
13862
|
-
"id": {
|
|
13863
|
-
"description": "unique identifier of this SSL certificate",
|
|
13864
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13865
|
-
"format": "uuid",
|
|
13866
|
-
"readOnly": true,
|
|
13867
|
-
"type": [
|
|
13868
|
-
"string"
|
|
13869
|
-
]
|
|
13870
|
-
}
|
|
13871
|
-
}
|
|
13872
|
-
},
|
|
13873
|
-
"updated_at": {
|
|
13874
|
-
"$ref": "#/definitions/ssl-endpoint/definitions/updated_at"
|
|
13875
|
-
}
|
|
13876
|
-
}
|
|
13877
|
-
},
|
|
13878
|
-
"stack": {
|
|
13879
|
-
"description": "Stacks are the different application execution environments available in the Heroku platform.",
|
|
13880
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13881
|
-
"stability": "production",
|
|
13882
|
-
"strictProperties": true,
|
|
13883
|
-
"title": "Heroku Platform API - Stack",
|
|
13884
|
-
"type": [
|
|
13885
|
-
"object"
|
|
13886
|
-
],
|
|
13887
|
-
"definitions": {
|
|
13888
|
-
"created_at": {
|
|
13889
|
-
"description": "when stack was introduced",
|
|
13890
|
-
"example": "2012-01-01T12:00:00Z",
|
|
13891
|
-
"format": "date-time",
|
|
13892
|
-
"readOnly": true,
|
|
13893
|
-
"type": [
|
|
13894
|
-
"string"
|
|
13895
|
-
]
|
|
13896
|
-
},
|
|
13897
|
-
"default": {
|
|
13898
|
-
"description": "indicates this stack is the default for new apps",
|
|
13899
|
-
"example": true,
|
|
13900
|
-
"readOnly": true,
|
|
13901
|
-
"type": [
|
|
13902
|
-
"boolean"
|
|
13903
|
-
]
|
|
13904
|
-
},
|
|
13905
|
-
"id": {
|
|
13906
|
-
"description": "unique identifier of stack",
|
|
13907
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13908
|
-
"format": "uuid",
|
|
13909
|
-
"readOnly": true,
|
|
13910
|
-
"type": [
|
|
13911
|
-
"string"
|
|
13912
|
-
]
|
|
13913
|
-
},
|
|
13914
|
-
"identity": {
|
|
13915
|
-
"anyOf": [
|
|
13916
|
-
{
|
|
13917
|
-
"$ref": "#/definitions/stack/definitions/name"
|
|
13918
|
-
},
|
|
13919
|
-
{
|
|
13920
|
-
"$ref": "#/definitions/stack/definitions/id"
|
|
13921
|
-
}
|
|
13922
|
-
]
|
|
13923
|
-
},
|
|
13924
|
-
"name": {
|
|
13925
|
-
"description": "unique name of stack",
|
|
13926
|
-
"example": "heroku-18",
|
|
13927
|
-
"readOnly": true,
|
|
13928
|
-
"type": [
|
|
13929
|
-
"string"
|
|
13930
|
-
]
|
|
13931
|
-
},
|
|
13932
|
-
"state": {
|
|
13933
|
-
"description": "availability of this stack: beta, deprecated or public",
|
|
13934
|
-
"example": "public",
|
|
13935
|
-
"readOnly": true,
|
|
13936
|
-
"type": [
|
|
13937
|
-
"string"
|
|
13938
|
-
]
|
|
13939
|
-
},
|
|
13940
|
-
"updated_at": {
|
|
13941
|
-
"description": "when stack was last modified",
|
|
13942
|
-
"example": "2012-01-01T12:00:00Z",
|
|
13943
|
-
"format": "date-time",
|
|
13944
|
-
"readOnly": true,
|
|
13945
|
-
"type": [
|
|
13946
|
-
"string"
|
|
13947
|
-
]
|
|
13948
|
-
}
|
|
13949
|
-
},
|
|
13950
|
-
"links": [
|
|
13951
|
-
{
|
|
13952
|
-
"description": "Stack info.",
|
|
13953
|
-
"href": "/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
|
|
13954
|
-
"method": "GET",
|
|
13955
|
-
"rel": "self",
|
|
13956
|
-
"targetSchema": {
|
|
13957
|
-
"$ref": "#/definitions/stack"
|
|
13958
|
-
},
|
|
13959
|
-
"title": "Info"
|
|
13960
|
-
},
|
|
13961
|
-
{
|
|
13962
|
-
"description": "List available stacks.",
|
|
13963
|
-
"href": "/stacks",
|
|
13964
|
-
"method": "GET",
|
|
13965
|
-
"rel": "instances",
|
|
13966
|
-
"targetSchema": {
|
|
13967
|
-
"items": {
|
|
13968
|
-
"$ref": "#/definitions/stack"
|
|
13969
|
-
},
|
|
13970
|
-
"type": [
|
|
13971
|
-
"array"
|
|
13972
|
-
]
|
|
13973
|
-
},
|
|
13974
|
-
"title": "List"
|
|
13975
|
-
}
|
|
13976
|
-
],
|
|
13977
|
-
"properties": {
|
|
13978
|
-
"default": {
|
|
13979
|
-
"$ref": "#/definitions/stack/definitions/default"
|
|
13765
|
+
}
|
|
13766
|
+
],
|
|
13767
|
+
"properties": {
|
|
13768
|
+
"default": {
|
|
13769
|
+
"$ref": "#/definitions/stack/definitions/default"
|
|
13980
13770
|
},
|
|
13981
13771
|
"created_at": {
|
|
13982
13772
|
"$ref": "#/definitions/stack/definitions/created_at"
|
|
@@ -14342,6 +14132,9 @@
|
|
|
14342
14132
|
"object"
|
|
14343
14133
|
]
|
|
14344
14134
|
},
|
|
14135
|
+
"targetSchema": {
|
|
14136
|
+
"$ref": "#/definitions/team-app"
|
|
14137
|
+
},
|
|
14345
14138
|
"title": "Create"
|
|
14346
14139
|
},
|
|
14347
14140
|
{
|
|
@@ -14349,6 +14142,9 @@
|
|
|
14349
14142
|
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
14350
14143
|
"method": "GET",
|
|
14351
14144
|
"rel": "self",
|
|
14145
|
+
"targetSchema": {
|
|
14146
|
+
"$ref": "#/definitions/team-app"
|
|
14147
|
+
},
|
|
14352
14148
|
"title": "Info"
|
|
14353
14149
|
},
|
|
14354
14150
|
{
|
|
@@ -14565,51 +14361,74 @@
|
|
|
14565
14361
|
}
|
|
14566
14362
|
}
|
|
14567
14363
|
},
|
|
14568
|
-
"team-
|
|
14569
|
-
"description": "A team feature represents a feature enabled on a team account.",
|
|
14364
|
+
"team-daily-usage": {
|
|
14570
14365
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
14366
|
+
"description": "Usage for an enterprise team at a daily resolution.",
|
|
14571
14367
|
"stability": "development",
|
|
14572
14368
|
"strictProperties": true,
|
|
14573
|
-
"title": "Heroku Platform API - Team
|
|
14369
|
+
"title": "Heroku Platform API - Team Daily Usage",
|
|
14574
14370
|
"type": [
|
|
14575
14371
|
"object"
|
|
14576
14372
|
],
|
|
14577
14373
|
"definitions": {
|
|
14578
|
-
"
|
|
14579
|
-
"description": "
|
|
14580
|
-
"example":
|
|
14581
|
-
"format": "date-time",
|
|
14374
|
+
"addons": {
|
|
14375
|
+
"description": "total add-on credits used",
|
|
14376
|
+
"example": 250.0,
|
|
14582
14377
|
"readOnly": true,
|
|
14583
14378
|
"type": [
|
|
14584
|
-
"
|
|
14379
|
+
"number"
|
|
14585
14380
|
]
|
|
14586
14381
|
},
|
|
14587
|
-
"
|
|
14588
|
-
"description": "
|
|
14589
|
-
"
|
|
14382
|
+
"app_usage_daily": {
|
|
14383
|
+
"description": "Usage for an app at a daily resolution.",
|
|
14384
|
+
"type": [
|
|
14385
|
+
"object"
|
|
14386
|
+
],
|
|
14387
|
+
"properties": {
|
|
14388
|
+
"addons": {
|
|
14389
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
14390
|
+
},
|
|
14391
|
+
"app_name": {
|
|
14392
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
14393
|
+
},
|
|
14394
|
+
"data": {
|
|
14395
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
14396
|
+
},
|
|
14397
|
+
"dynos": {
|
|
14398
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
14399
|
+
},
|
|
14400
|
+
"partner": {
|
|
14401
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
14402
|
+
}
|
|
14403
|
+
}
|
|
14404
|
+
},
|
|
14405
|
+
"data": {
|
|
14406
|
+
"description": "total add-on credits used for first party add-ons",
|
|
14407
|
+
"example": 34.89,
|
|
14590
14408
|
"readOnly": true,
|
|
14591
14409
|
"type": [
|
|
14592
|
-
"
|
|
14410
|
+
"number"
|
|
14593
14411
|
]
|
|
14594
14412
|
},
|
|
14595
|
-
"
|
|
14596
|
-
"description": "
|
|
14597
|
-
"example": "
|
|
14413
|
+
"date": {
|
|
14414
|
+
"description": "date of the usage",
|
|
14415
|
+
"example": "2019-01-01",
|
|
14416
|
+
"format": "date",
|
|
14598
14417
|
"readOnly": true,
|
|
14599
14418
|
"type": [
|
|
14600
14419
|
"string"
|
|
14601
14420
|
]
|
|
14602
14421
|
},
|
|
14603
|
-
"
|
|
14604
|
-
"description": "
|
|
14605
|
-
"example":
|
|
14606
|
-
"readOnly":
|
|
14422
|
+
"dynos": {
|
|
14423
|
+
"description": "dynos used",
|
|
14424
|
+
"example": 1.548,
|
|
14425
|
+
"readOnly": true,
|
|
14607
14426
|
"type": [
|
|
14608
|
-
"
|
|
14427
|
+
"number"
|
|
14609
14428
|
]
|
|
14610
14429
|
},
|
|
14611
14430
|
"id": {
|
|
14612
|
-
"description": "
|
|
14431
|
+
"description": "team identifier",
|
|
14613
14432
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
14614
14433
|
"format": "uuid",
|
|
14615
14434
|
"readOnly": true,
|
|
@@ -14617,9 +14436,173 @@
|
|
|
14617
14436
|
"string"
|
|
14618
14437
|
]
|
|
14619
14438
|
},
|
|
14620
|
-
"
|
|
14621
|
-
"
|
|
14622
|
-
|
|
14439
|
+
"name": {
|
|
14440
|
+
"description": "name of the team",
|
|
14441
|
+
"example": "ops",
|
|
14442
|
+
"readOnly": true,
|
|
14443
|
+
"type": [
|
|
14444
|
+
"string"
|
|
14445
|
+
]
|
|
14446
|
+
},
|
|
14447
|
+
"partner": {
|
|
14448
|
+
"description": "total add-on credits used for third party add-ons",
|
|
14449
|
+
"example": 12.34,
|
|
14450
|
+
"readOnly": true,
|
|
14451
|
+
"type": [
|
|
14452
|
+
"number"
|
|
14453
|
+
]
|
|
14454
|
+
},
|
|
14455
|
+
"space": {
|
|
14456
|
+
"description": "space credits used",
|
|
14457
|
+
"example": 1.548,
|
|
14458
|
+
"readOnly": true,
|
|
14459
|
+
"type": [
|
|
14460
|
+
"number"
|
|
14461
|
+
]
|
|
14462
|
+
},
|
|
14463
|
+
"start_date": {
|
|
14464
|
+
"description": "range start date",
|
|
14465
|
+
"example": "2019-01-25",
|
|
14466
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
14467
|
+
"readOnly": true,
|
|
14468
|
+
"type": [
|
|
14469
|
+
"string"
|
|
14470
|
+
]
|
|
14471
|
+
},
|
|
14472
|
+
"end_date": {
|
|
14473
|
+
"description": "range end date",
|
|
14474
|
+
"example": "2019-02-25",
|
|
14475
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
14476
|
+
"readOnly": true,
|
|
14477
|
+
"type": [
|
|
14478
|
+
"string"
|
|
14479
|
+
]
|
|
14480
|
+
}
|
|
14481
|
+
},
|
|
14482
|
+
"links": [
|
|
14483
|
+
{
|
|
14484
|
+
"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",
|
|
14485
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
|
|
14486
|
+
"method": "GET",
|
|
14487
|
+
"title": "Info",
|
|
14488
|
+
"schema": {
|
|
14489
|
+
"properties": {
|
|
14490
|
+
"start": {
|
|
14491
|
+
"$ref": "#/definitions/team-daily-usage/definitions/start_date"
|
|
14492
|
+
},
|
|
14493
|
+
"end": {
|
|
14494
|
+
"$ref": "#/definitions/team-daily-usage/definitions/end_date"
|
|
14495
|
+
}
|
|
14496
|
+
},
|
|
14497
|
+
"required": [
|
|
14498
|
+
"start"
|
|
14499
|
+
],
|
|
14500
|
+
"type": [
|
|
14501
|
+
"object"
|
|
14502
|
+
]
|
|
14503
|
+
},
|
|
14504
|
+
"rel": "instances",
|
|
14505
|
+
"targetSchema": {
|
|
14506
|
+
"items": {
|
|
14507
|
+
"$ref": "#/definitions/team-daily-usage"
|
|
14508
|
+
},
|
|
14509
|
+
"type": [
|
|
14510
|
+
"array"
|
|
14511
|
+
]
|
|
14512
|
+
}
|
|
14513
|
+
}
|
|
14514
|
+
],
|
|
14515
|
+
"properties": {
|
|
14516
|
+
"addons": {
|
|
14517
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
|
14518
|
+
},
|
|
14519
|
+
"apps": {
|
|
14520
|
+
"description": "app usage in the team",
|
|
14521
|
+
"type": [
|
|
14522
|
+
"array"
|
|
14523
|
+
],
|
|
14524
|
+
"items": {
|
|
14525
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
|
14526
|
+
}
|
|
14527
|
+
},
|
|
14528
|
+
"data": {
|
|
14529
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
|
14530
|
+
},
|
|
14531
|
+
"date": {
|
|
14532
|
+
"$ref": "#/definitions/team-daily-usage/definitions/date"
|
|
14533
|
+
},
|
|
14534
|
+
"dynos": {
|
|
14535
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
|
14536
|
+
},
|
|
14537
|
+
"id": {
|
|
14538
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
|
14539
|
+
},
|
|
14540
|
+
"name": {
|
|
14541
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
|
14542
|
+
},
|
|
14543
|
+
"partner": {
|
|
14544
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
|
14545
|
+
},
|
|
14546
|
+
"space": {
|
|
14547
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
|
14548
|
+
}
|
|
14549
|
+
}
|
|
14550
|
+
},
|
|
14551
|
+
"team-feature": {
|
|
14552
|
+
"description": "A team feature represents a feature enabled on a team account.",
|
|
14553
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
14554
|
+
"stability": "development",
|
|
14555
|
+
"strictProperties": true,
|
|
14556
|
+
"title": "Heroku Platform API - Team Feature",
|
|
14557
|
+
"type": [
|
|
14558
|
+
"object"
|
|
14559
|
+
],
|
|
14560
|
+
"definitions": {
|
|
14561
|
+
"created_at": {
|
|
14562
|
+
"description": "when team feature was created",
|
|
14563
|
+
"example": "2012-01-01T12:00:00Z",
|
|
14564
|
+
"format": "date-time",
|
|
14565
|
+
"readOnly": true,
|
|
14566
|
+
"type": [
|
|
14567
|
+
"string"
|
|
14568
|
+
]
|
|
14569
|
+
},
|
|
14570
|
+
"description": {
|
|
14571
|
+
"description": "description of team feature",
|
|
14572
|
+
"example": "Causes account to example.",
|
|
14573
|
+
"readOnly": true,
|
|
14574
|
+
"type": [
|
|
14575
|
+
"string"
|
|
14576
|
+
]
|
|
14577
|
+
},
|
|
14578
|
+
"doc_url": {
|
|
14579
|
+
"description": "documentation URL of team feature",
|
|
14580
|
+
"example": "http://devcenter.heroku.com/articles/example",
|
|
14581
|
+
"readOnly": true,
|
|
14582
|
+
"type": [
|
|
14583
|
+
"string"
|
|
14584
|
+
]
|
|
14585
|
+
},
|
|
14586
|
+
"enabled": {
|
|
14587
|
+
"description": "whether or not team feature has been enabled",
|
|
14588
|
+
"example": true,
|
|
14589
|
+
"readOnly": false,
|
|
14590
|
+
"type": [
|
|
14591
|
+
"boolean"
|
|
14592
|
+
]
|
|
14593
|
+
},
|
|
14594
|
+
"id": {
|
|
14595
|
+
"description": "unique identifier of team feature",
|
|
14596
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
14597
|
+
"format": "uuid",
|
|
14598
|
+
"readOnly": true,
|
|
14599
|
+
"type": [
|
|
14600
|
+
"string"
|
|
14601
|
+
]
|
|
14602
|
+
},
|
|
14603
|
+
"identity": {
|
|
14604
|
+
"anyOf": [
|
|
14605
|
+
{
|
|
14623
14606
|
"$ref": "#/definitions/team-feature/definitions/id"
|
|
14624
14607
|
},
|
|
14625
14608
|
{
|
|
@@ -14820,6 +14803,9 @@
|
|
|
14820
14803
|
"type": [
|
|
14821
14804
|
"object"
|
|
14822
14805
|
]
|
|
14806
|
+
},
|
|
14807
|
+
"targetSchema": {
|
|
14808
|
+
"$ref": "#/definitions/team-invitation"
|
|
14823
14809
|
}
|
|
14824
14810
|
},
|
|
14825
14811
|
{
|
|
@@ -14827,7 +14813,10 @@
|
|
|
14827
14813
|
"title": "Revoke",
|
|
14828
14814
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Fidentity)}",
|
|
14829
14815
|
"method": "DELETE",
|
|
14830
|
-
"rel": "self"
|
|
14816
|
+
"rel": "self",
|
|
14817
|
+
"targetSchema": {
|
|
14818
|
+
"$ref": "#/definitions/team-invitation"
|
|
14819
|
+
}
|
|
14831
14820
|
},
|
|
14832
14821
|
{
|
|
14833
14822
|
"description": "Get an invitation by its token",
|
|
@@ -15447,282 +15436,7 @@
|
|
|
15447
15436
|
}
|
|
15448
15437
|
}
|
|
15449
15438
|
},
|
|
15450
|
-
"team-
|
|
15451
|
-
"description": "Tracks a Team's Preferences",
|
|
15452
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15453
|
-
"stability": "development",
|
|
15454
|
-
"strictProperties": true,
|
|
15455
|
-
"title": "Heroku Platform API - Team Preferences",
|
|
15456
|
-
"type": [
|
|
15457
|
-
"object"
|
|
15458
|
-
],
|
|
15459
|
-
"definitions": {
|
|
15460
|
-
"default-permission": {
|
|
15461
|
-
"description": "The default permission used when adding new members to the team",
|
|
15462
|
-
"example": "member",
|
|
15463
|
-
"readOnly": false,
|
|
15464
|
-
"enum": [
|
|
15465
|
-
"admin",
|
|
15466
|
-
"member",
|
|
15467
|
-
"viewer",
|
|
15468
|
-
null
|
|
15469
|
-
],
|
|
15470
|
-
"type": [
|
|
15471
|
-
"null",
|
|
15472
|
-
"string"
|
|
15473
|
-
]
|
|
15474
|
-
},
|
|
15475
|
-
"identity": {
|
|
15476
|
-
"$ref": "#/definitions/team/definitions/identity"
|
|
15477
|
-
},
|
|
15478
|
-
"whitelisting-enabled": {
|
|
15479
|
-
"deactivate_on": "2021-02-05",
|
|
15480
|
-
"description": "Whether whitelisting rules should be applied to add-on installations. Deprecated in favor of `addons-controls`",
|
|
15481
|
-
"example": true,
|
|
15482
|
-
"readOnly": false,
|
|
15483
|
-
"type": [
|
|
15484
|
-
"boolean",
|
|
15485
|
-
"null"
|
|
15486
|
-
]
|
|
15487
|
-
},
|
|
15488
|
-
"addons-controls": {
|
|
15489
|
-
"description": "Whether add-on service rules should be applied to add-on installations",
|
|
15490
|
-
"example": true,
|
|
15491
|
-
"readOnly": false,
|
|
15492
|
-
"type": [
|
|
15493
|
-
"boolean",
|
|
15494
|
-
"null"
|
|
15495
|
-
]
|
|
15496
|
-
}
|
|
15497
|
-
},
|
|
15498
|
-
"links": [
|
|
15499
|
-
{
|
|
15500
|
-
"description": "Retrieve Team Preferences",
|
|
15501
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
15502
|
-
"method": "GET",
|
|
15503
|
-
"rel": "self",
|
|
15504
|
-
"targetSchema": {
|
|
15505
|
-
"$ref": "#/definitions/team-preferences"
|
|
15506
|
-
},
|
|
15507
|
-
"title": "List"
|
|
15508
|
-
},
|
|
15509
|
-
{
|
|
15510
|
-
"description": "Update Team Preferences",
|
|
15511
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
15512
|
-
"method": "PATCH",
|
|
15513
|
-
"rel": "update",
|
|
15514
|
-
"schema": {
|
|
15515
|
-
"type": [
|
|
15516
|
-
"object"
|
|
15517
|
-
],
|
|
15518
|
-
"properties": {
|
|
15519
|
-
"whitelisting-enabled": {
|
|
15520
|
-
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
15521
|
-
},
|
|
15522
|
-
"addons-controls": {
|
|
15523
|
-
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
15524
|
-
}
|
|
15525
|
-
}
|
|
15526
|
-
},
|
|
15527
|
-
"targetSchema": {
|
|
15528
|
-
"$ref": "#/definitions/team-preferences"
|
|
15529
|
-
},
|
|
15530
|
-
"title": "Update"
|
|
15531
|
-
}
|
|
15532
|
-
],
|
|
15533
|
-
"properties": {
|
|
15534
|
-
"default-permission": {
|
|
15535
|
-
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
|
15536
|
-
},
|
|
15537
|
-
"whitelisting-enabled": {
|
|
15538
|
-
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
15539
|
-
},
|
|
15540
|
-
"addons-controls": {
|
|
15541
|
-
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
15542
|
-
}
|
|
15543
|
-
}
|
|
15544
|
-
},
|
|
15545
|
-
"team-space": {
|
|
15546
|
-
"description": "A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.",
|
|
15547
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15548
|
-
"stability": "prototype",
|
|
15549
|
-
"strictProperties": true,
|
|
15550
|
-
"title": "Heroku Platform API - Space",
|
|
15551
|
-
"type": [
|
|
15552
|
-
"object"
|
|
15553
|
-
],
|
|
15554
|
-
"links": [
|
|
15555
|
-
{
|
|
15556
|
-
"description": "List spaces owned by the team",
|
|
15557
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/spaces",
|
|
15558
|
-
"method": "GET",
|
|
15559
|
-
"rel": "instances",
|
|
15560
|
-
"targetSchema": {
|
|
15561
|
-
"items": {
|
|
15562
|
-
"$ref": "#/definitions/space"
|
|
15563
|
-
},
|
|
15564
|
-
"type": [
|
|
15565
|
-
"array"
|
|
15566
|
-
]
|
|
15567
|
-
},
|
|
15568
|
-
"title": "List"
|
|
15569
|
-
}
|
|
15570
|
-
]
|
|
15571
|
-
},
|
|
15572
|
-
"team-usage-daily": {
|
|
15573
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15574
|
-
"description": "Usage for an enterprise team at a daily resolution.",
|
|
15575
|
-
"stability": "development",
|
|
15576
|
-
"strictProperties": true,
|
|
15577
|
-
"title": "Heroku Platform API - Team Daily Usage",
|
|
15578
|
-
"type": [
|
|
15579
|
-
"object"
|
|
15580
|
-
],
|
|
15581
|
-
"definitions": {
|
|
15582
|
-
"addons": {
|
|
15583
|
-
"description": "total add-on credits used",
|
|
15584
|
-
"example": 250.0,
|
|
15585
|
-
"readOnly": true,
|
|
15586
|
-
"type": [
|
|
15587
|
-
"number"
|
|
15588
|
-
]
|
|
15589
|
-
},
|
|
15590
|
-
"app_usage_daily": {
|
|
15591
|
-
"description": "Usage for an app at a daily resolution.",
|
|
15592
|
-
"type": [
|
|
15593
|
-
"object"
|
|
15594
|
-
],
|
|
15595
|
-
"properties": {
|
|
15596
|
-
"addons": {
|
|
15597
|
-
"$ref": "#/definitions/team-usage-daily/definitions/addons"
|
|
15598
|
-
},
|
|
15599
|
-
"app_name": {
|
|
15600
|
-
"$ref": "#/definitions/app/definitions/name"
|
|
15601
|
-
},
|
|
15602
|
-
"data": {
|
|
15603
|
-
"$ref": "#/definitions/team-usage-daily/definitions/data"
|
|
15604
|
-
},
|
|
15605
|
-
"dynos": {
|
|
15606
|
-
"$ref": "#/definitions/team-usage-daily/definitions/dynos"
|
|
15607
|
-
},
|
|
15608
|
-
"partner": {
|
|
15609
|
-
"$ref": "#/definitions/team-usage-daily/definitions/partner"
|
|
15610
|
-
}
|
|
15611
|
-
}
|
|
15612
|
-
},
|
|
15613
|
-
"data": {
|
|
15614
|
-
"description": "total add-on credits used for first party add-ons",
|
|
15615
|
-
"example": 34.89,
|
|
15616
|
-
"readOnly": true,
|
|
15617
|
-
"type": [
|
|
15618
|
-
"number"
|
|
15619
|
-
]
|
|
15620
|
-
},
|
|
15621
|
-
"date": {
|
|
15622
|
-
"description": "date of the usage",
|
|
15623
|
-
"example": "2019-01-01",
|
|
15624
|
-
"format": "date",
|
|
15625
|
-
"readOnly": true,
|
|
15626
|
-
"type": [
|
|
15627
|
-
"string"
|
|
15628
|
-
]
|
|
15629
|
-
},
|
|
15630
|
-
"dynos": {
|
|
15631
|
-
"description": "dynos used",
|
|
15632
|
-
"example": 1.548,
|
|
15633
|
-
"readOnly": true,
|
|
15634
|
-
"type": [
|
|
15635
|
-
"number"
|
|
15636
|
-
]
|
|
15637
|
-
},
|
|
15638
|
-
"id": {
|
|
15639
|
-
"description": "team identifier",
|
|
15640
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
15641
|
-
"format": "uuid",
|
|
15642
|
-
"readOnly": true,
|
|
15643
|
-
"type": [
|
|
15644
|
-
"string"
|
|
15645
|
-
]
|
|
15646
|
-
},
|
|
15647
|
-
"name": {
|
|
15648
|
-
"description": "name of the team",
|
|
15649
|
-
"example": "ops",
|
|
15650
|
-
"readOnly": true,
|
|
15651
|
-
"type": [
|
|
15652
|
-
"string"
|
|
15653
|
-
]
|
|
15654
|
-
},
|
|
15655
|
-
"partner": {
|
|
15656
|
-
"description": "total add-on credits used for third party add-ons",
|
|
15657
|
-
"example": 12.34,
|
|
15658
|
-
"readOnly": true,
|
|
15659
|
-
"type": [
|
|
15660
|
-
"number"
|
|
15661
|
-
]
|
|
15662
|
-
},
|
|
15663
|
-
"space": {
|
|
15664
|
-
"description": "space credits used",
|
|
15665
|
-
"example": 1.548,
|
|
15666
|
-
"readOnly": true,
|
|
15667
|
-
"type": [
|
|
15668
|
-
"number"
|
|
15669
|
-
]
|
|
15670
|
-
}
|
|
15671
|
-
},
|
|
15672
|
-
"links": [
|
|
15673
|
-
{
|
|
15674
|
-
"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.",
|
|
15675
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
|
|
15676
|
-
"method": "GET",
|
|
15677
|
-
"title": "Info",
|
|
15678
|
-
"rel": "instances",
|
|
15679
|
-
"targetSchema": {
|
|
15680
|
-
"items": {
|
|
15681
|
-
"$ref": "#/definitions/team-usage-daily"
|
|
15682
|
-
},
|
|
15683
|
-
"type": [
|
|
15684
|
-
"array"
|
|
15685
|
-
]
|
|
15686
|
-
}
|
|
15687
|
-
}
|
|
15688
|
-
],
|
|
15689
|
-
"properties": {
|
|
15690
|
-
"addons": {
|
|
15691
|
-
"$ref": "#/definitions/team-usage-daily/definitions/addons"
|
|
15692
|
-
},
|
|
15693
|
-
"apps": {
|
|
15694
|
-
"description": "app usage in the team",
|
|
15695
|
-
"type": [
|
|
15696
|
-
"array"
|
|
15697
|
-
],
|
|
15698
|
-
"items": {
|
|
15699
|
-
"$ref": "#/definitions/team-usage-daily/definitions/app_usage_daily"
|
|
15700
|
-
}
|
|
15701
|
-
},
|
|
15702
|
-
"data": {
|
|
15703
|
-
"$ref": "#/definitions/team-usage-daily/definitions/data"
|
|
15704
|
-
},
|
|
15705
|
-
"date": {
|
|
15706
|
-
"$ref": "#/definitions/team-usage-daily/definitions/date"
|
|
15707
|
-
},
|
|
15708
|
-
"dynos": {
|
|
15709
|
-
"$ref": "#/definitions/team-usage-daily/definitions/dynos"
|
|
15710
|
-
},
|
|
15711
|
-
"id": {
|
|
15712
|
-
"$ref": "#/definitions/team-usage-daily/definitions/id"
|
|
15713
|
-
},
|
|
15714
|
-
"name": {
|
|
15715
|
-
"$ref": "#/definitions/team-usage-daily/definitions/name"
|
|
15716
|
-
},
|
|
15717
|
-
"partner": {
|
|
15718
|
-
"$ref": "#/definitions/team-usage-daily/definitions/partner"
|
|
15719
|
-
},
|
|
15720
|
-
"space": {
|
|
15721
|
-
"$ref": "#/definitions/team-usage-daily/definitions/space"
|
|
15722
|
-
}
|
|
15723
|
-
}
|
|
15724
|
-
},
|
|
15725
|
-
"team-usage-monthly": {
|
|
15439
|
+
"team-monthly-usage": {
|
|
15726
15440
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15727
15441
|
"description": "Usage for an enterprise team at a monthly resolution.",
|
|
15728
15442
|
"stability": "development",
|
|
@@ -15747,19 +15461,19 @@
|
|
|
15747
15461
|
],
|
|
15748
15462
|
"properties": {
|
|
15749
15463
|
"addons": {
|
|
15750
|
-
"$ref": "#/definitions/team-usage
|
|
15464
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
15751
15465
|
},
|
|
15752
15466
|
"app_name": {
|
|
15753
15467
|
"$ref": "#/definitions/app/definitions/name"
|
|
15754
15468
|
},
|
|
15755
15469
|
"data": {
|
|
15756
|
-
"$ref": "#/definitions/team-usage
|
|
15470
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
15757
15471
|
},
|
|
15758
15472
|
"dynos": {
|
|
15759
|
-
"$ref": "#/definitions/team-usage
|
|
15473
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
15760
15474
|
},
|
|
15761
15475
|
"partner": {
|
|
15762
|
-
"$ref": "#/definitions/team-usage
|
|
15476
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
15763
15477
|
}
|
|
15764
15478
|
}
|
|
15765
15479
|
},
|
|
@@ -15828,18 +15542,52 @@
|
|
|
15828
15542
|
"type": [
|
|
15829
15543
|
"number"
|
|
15830
15544
|
]
|
|
15545
|
+
},
|
|
15546
|
+
"start_date": {
|
|
15547
|
+
"description": "range start date",
|
|
15548
|
+
"example": "2019-01",
|
|
15549
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
15550
|
+
"readOnly": true,
|
|
15551
|
+
"type": [
|
|
15552
|
+
"string"
|
|
15553
|
+
]
|
|
15554
|
+
},
|
|
15555
|
+
"end_date": {
|
|
15556
|
+
"description": "range end date",
|
|
15557
|
+
"example": "2019-02",
|
|
15558
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
|
15559
|
+
"readOnly": true,
|
|
15560
|
+
"type": [
|
|
15561
|
+
"string"
|
|
15562
|
+
]
|
|
15831
15563
|
}
|
|
15832
15564
|
},
|
|
15833
15565
|
"links": [
|
|
15834
15566
|
{
|
|
15835
|
-
"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
|
|
15567
|
+
"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",
|
|
15836
15568
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/monthly",
|
|
15837
15569
|
"method": "GET",
|
|
15838
15570
|
"title": "Info",
|
|
15571
|
+
"schema": {
|
|
15572
|
+
"properties": {
|
|
15573
|
+
"start": {
|
|
15574
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/start_date"
|
|
15575
|
+
},
|
|
15576
|
+
"end": {
|
|
15577
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/end_date"
|
|
15578
|
+
}
|
|
15579
|
+
},
|
|
15580
|
+
"required": [
|
|
15581
|
+
"start"
|
|
15582
|
+
],
|
|
15583
|
+
"type": [
|
|
15584
|
+
"object"
|
|
15585
|
+
]
|
|
15586
|
+
},
|
|
15839
15587
|
"rel": "instances",
|
|
15840
15588
|
"targetSchema": {
|
|
15841
15589
|
"items": {
|
|
15842
|
-
"$ref": "#/definitions/team-usage
|
|
15590
|
+
"$ref": "#/definitions/team-monthly-usage"
|
|
15843
15591
|
},
|
|
15844
15592
|
"type": [
|
|
15845
15593
|
"array"
|
|
@@ -15849,7 +15597,7 @@
|
|
|
15849
15597
|
],
|
|
15850
15598
|
"properties": {
|
|
15851
15599
|
"addons": {
|
|
15852
|
-
"$ref": "#/definitions/team-usage
|
|
15600
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
|
15853
15601
|
},
|
|
15854
15602
|
"apps": {
|
|
15855
15603
|
"description": "app usage in the team",
|
|
@@ -15857,35 +15605,141 @@
|
|
|
15857
15605
|
"array"
|
|
15858
15606
|
],
|
|
15859
15607
|
"items": {
|
|
15860
|
-
"$ref": "#/definitions/team-usage
|
|
15608
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
|
15861
15609
|
}
|
|
15862
15610
|
},
|
|
15863
15611
|
"connect": {
|
|
15864
|
-
"$ref": "#/definitions/team-usage
|
|
15612
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
|
15865
15613
|
},
|
|
15866
15614
|
"data": {
|
|
15867
|
-
"$ref": "#/definitions/team-usage
|
|
15615
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
|
15868
15616
|
},
|
|
15869
15617
|
"dynos": {
|
|
15870
|
-
"$ref": "#/definitions/team-usage
|
|
15618
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
|
15871
15619
|
},
|
|
15872
15620
|
"id": {
|
|
15873
|
-
"$ref": "#/definitions/team-usage
|
|
15621
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
|
15874
15622
|
},
|
|
15875
15623
|
"month": {
|
|
15876
|
-
"$ref": "#/definitions/team-usage
|
|
15624
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/month"
|
|
15877
15625
|
},
|
|
15878
15626
|
"name": {
|
|
15879
|
-
"$ref": "#/definitions/team-usage
|
|
15627
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
|
15880
15628
|
},
|
|
15881
15629
|
"partner": {
|
|
15882
|
-
"$ref": "#/definitions/team-usage
|
|
15630
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
|
15883
15631
|
},
|
|
15884
15632
|
"space": {
|
|
15885
|
-
"$ref": "#/definitions/team-usage
|
|
15633
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
|
15634
|
+
}
|
|
15635
|
+
}
|
|
15636
|
+
},
|
|
15637
|
+
"team-preferences": {
|
|
15638
|
+
"description": "Tracks a Team's Preferences",
|
|
15639
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15640
|
+
"stability": "development",
|
|
15641
|
+
"strictProperties": true,
|
|
15642
|
+
"title": "Heroku Platform API - Team Preferences",
|
|
15643
|
+
"type": [
|
|
15644
|
+
"object"
|
|
15645
|
+
],
|
|
15646
|
+
"definitions": {
|
|
15647
|
+
"default-permission": {
|
|
15648
|
+
"description": "The default permission used when adding new members to the team",
|
|
15649
|
+
"example": "member",
|
|
15650
|
+
"readOnly": false,
|
|
15651
|
+
"enum": [
|
|
15652
|
+
"admin",
|
|
15653
|
+
"member",
|
|
15654
|
+
"viewer",
|
|
15655
|
+
null
|
|
15656
|
+
],
|
|
15657
|
+
"type": [
|
|
15658
|
+
"null",
|
|
15659
|
+
"string"
|
|
15660
|
+
]
|
|
15661
|
+
},
|
|
15662
|
+
"identity": {
|
|
15663
|
+
"$ref": "#/definitions/team/definitions/identity"
|
|
15664
|
+
},
|
|
15665
|
+
"addons-controls": {
|
|
15666
|
+
"description": "Whether add-on service rules should be applied to add-on installations",
|
|
15667
|
+
"example": true,
|
|
15668
|
+
"readOnly": false,
|
|
15669
|
+
"type": [
|
|
15670
|
+
"boolean",
|
|
15671
|
+
"null"
|
|
15672
|
+
]
|
|
15673
|
+
}
|
|
15674
|
+
},
|
|
15675
|
+
"links": [
|
|
15676
|
+
{
|
|
15677
|
+
"description": "Retrieve Team Preferences",
|
|
15678
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
15679
|
+
"method": "GET",
|
|
15680
|
+
"rel": "self",
|
|
15681
|
+
"targetSchema": {
|
|
15682
|
+
"$ref": "#/definitions/team-preferences"
|
|
15683
|
+
},
|
|
15684
|
+
"title": "List"
|
|
15685
|
+
},
|
|
15686
|
+
{
|
|
15687
|
+
"description": "Update Team Preferences",
|
|
15688
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
15689
|
+
"method": "PATCH",
|
|
15690
|
+
"rel": "update",
|
|
15691
|
+
"schema": {
|
|
15692
|
+
"type": [
|
|
15693
|
+
"object"
|
|
15694
|
+
],
|
|
15695
|
+
"properties": {
|
|
15696
|
+
"addons-controls": {
|
|
15697
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
15698
|
+
}
|
|
15699
|
+
}
|
|
15700
|
+
},
|
|
15701
|
+
"targetSchema": {
|
|
15702
|
+
"$ref": "#/definitions/team-preferences"
|
|
15703
|
+
},
|
|
15704
|
+
"title": "Update"
|
|
15705
|
+
}
|
|
15706
|
+
],
|
|
15707
|
+
"properties": {
|
|
15708
|
+
"default-permission": {
|
|
15709
|
+
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
|
15710
|
+
},
|
|
15711
|
+
"addons-controls": {
|
|
15712
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
|
15886
15713
|
}
|
|
15887
15714
|
}
|
|
15888
15715
|
},
|
|
15716
|
+
"team-space": {
|
|
15717
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
|
15718
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15719
|
+
"stability": "prototype",
|
|
15720
|
+
"strictProperties": true,
|
|
15721
|
+
"title": "Heroku Platform API - Team Space",
|
|
15722
|
+
"type": [
|
|
15723
|
+
"object"
|
|
15724
|
+
],
|
|
15725
|
+
"links": [
|
|
15726
|
+
{
|
|
15727
|
+
"description": "List spaces owned by the team",
|
|
15728
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/spaces",
|
|
15729
|
+
"method": "GET",
|
|
15730
|
+
"rel": "instances",
|
|
15731
|
+
"targetSchema": {
|
|
15732
|
+
"items": {
|
|
15733
|
+
"$ref": "#/definitions/space"
|
|
15734
|
+
},
|
|
15735
|
+
"type": [
|
|
15736
|
+
"array"
|
|
15737
|
+
]
|
|
15738
|
+
},
|
|
15739
|
+
"title": "List"
|
|
15740
|
+
}
|
|
15741
|
+
]
|
|
15742
|
+
},
|
|
15889
15743
|
"team": {
|
|
15890
15744
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
15891
15745
|
"description": "Teams allow you to manage access to a shared group of applications and other resources.",
|
|
@@ -15965,12 +15819,11 @@
|
|
|
15965
15819
|
"id": {
|
|
15966
15820
|
"$ref": "#/definitions/identity-provider/definitions/id"
|
|
15967
15821
|
},
|
|
15968
|
-
"
|
|
15969
|
-
"
|
|
15970
|
-
|
|
15971
|
-
|
|
15972
|
-
|
|
15973
|
-
]
|
|
15822
|
+
"name": {
|
|
15823
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
|
15824
|
+
},
|
|
15825
|
+
"owner": {
|
|
15826
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
|
15974
15827
|
}
|
|
15975
15828
|
}
|
|
15976
15829
|
},
|
|
@@ -16171,6 +16024,9 @@
|
|
|
16171
16024
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
|
16172
16025
|
"method": "GET",
|
|
16173
16026
|
"rel": "self",
|
|
16027
|
+
"targetSchema": {
|
|
16028
|
+
"$ref": "#/definitions/team"
|
|
16029
|
+
},
|
|
16174
16030
|
"title": "Info"
|
|
16175
16031
|
},
|
|
16176
16032
|
{
|
|
@@ -17438,6 +17294,9 @@
|
|
|
17438
17294
|
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/vpn-connections/{(%23%2Fdefinitions%2Fvpn-connection%2Fdefinitions%2Fidentity)}",
|
|
17439
17295
|
"rel": "empty",
|
|
17440
17296
|
"method": "DELETE",
|
|
17297
|
+
"targetSchema": {
|
|
17298
|
+
"$ref": "#/definitions/vpn-connection"
|
|
17299
|
+
},
|
|
17441
17300
|
"title": "Destroy"
|
|
17442
17301
|
},
|
|
17443
17302
|
{
|
|
@@ -17489,160 +17348,6 @@
|
|
|
17489
17348
|
"title": "Update"
|
|
17490
17349
|
}
|
|
17491
17350
|
]
|
|
17492
|
-
},
|
|
17493
|
-
"whitelisted-add-on-service": {
|
|
17494
|
-
"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.",
|
|
17495
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
17496
|
-
"stability": "prototype",
|
|
17497
|
-
"strictProperties": true,
|
|
17498
|
-
"title": "Heroku Platform API - Whitelisted Entity",
|
|
17499
|
-
"type": [
|
|
17500
|
-
"object"
|
|
17501
|
-
],
|
|
17502
|
-
"definitions": {
|
|
17503
|
-
"added_at": {
|
|
17504
|
-
"description": "when the add-on service was whitelisted",
|
|
17505
|
-
"example": "2012-01-01T12:00:00Z",
|
|
17506
|
-
"format": "date-time",
|
|
17507
|
-
"readOnly": true,
|
|
17508
|
-
"type": [
|
|
17509
|
-
"string"
|
|
17510
|
-
]
|
|
17511
|
-
},
|
|
17512
|
-
"added_by": {
|
|
17513
|
-
"description": "the user which whitelisted the Add-on Service",
|
|
17514
|
-
"properties": {
|
|
17515
|
-
"email": {
|
|
17516
|
-
"$ref": "#/definitions/account/definitions/email",
|
|
17517
|
-
"type": [
|
|
17518
|
-
"string",
|
|
17519
|
-
"null"
|
|
17520
|
-
]
|
|
17521
|
-
},
|
|
17522
|
-
"id": {
|
|
17523
|
-
"$ref": "#/definitions/account/definitions/id",
|
|
17524
|
-
"type": [
|
|
17525
|
-
"string",
|
|
17526
|
-
"null"
|
|
17527
|
-
]
|
|
17528
|
-
}
|
|
17529
|
-
},
|
|
17530
|
-
"readOnly": true,
|
|
17531
|
-
"type": [
|
|
17532
|
-
"object"
|
|
17533
|
-
]
|
|
17534
|
-
},
|
|
17535
|
-
"addon_service": {
|
|
17536
|
-
"description": "the Add-on Service whitelisted for use",
|
|
17537
|
-
"properties": {
|
|
17538
|
-
"id": {
|
|
17539
|
-
"$ref": "#/definitions/add-on-service/definitions/id"
|
|
17540
|
-
},
|
|
17541
|
-
"name": {
|
|
17542
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
17543
|
-
},
|
|
17544
|
-
"human_name": {
|
|
17545
|
-
"$ref": "#/definitions/add-on-service/definitions/human_name"
|
|
17546
|
-
}
|
|
17547
|
-
},
|
|
17548
|
-
"readOnly": true,
|
|
17549
|
-
"type": [
|
|
17550
|
-
"object"
|
|
17551
|
-
]
|
|
17552
|
-
},
|
|
17553
|
-
"id": {
|
|
17554
|
-
"description": "unique identifier for this whitelisting entity",
|
|
17555
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
17556
|
-
"format": "uuid",
|
|
17557
|
-
"readOnly": true,
|
|
17558
|
-
"type": [
|
|
17559
|
-
"string"
|
|
17560
|
-
]
|
|
17561
|
-
},
|
|
17562
|
-
"identity": {
|
|
17563
|
-
"anyOf": [
|
|
17564
|
-
{
|
|
17565
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/id"
|
|
17566
|
-
},
|
|
17567
|
-
{
|
|
17568
|
-
"$ref": "#/definitions/add-on-service/definitions/name"
|
|
17569
|
-
}
|
|
17570
|
-
]
|
|
17571
|
-
}
|
|
17572
|
-
},
|
|
17573
|
-
"links": [
|
|
17574
|
-
{
|
|
17575
|
-
"deactivate_on": "2021-02-05",
|
|
17576
|
-
"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.",
|
|
17577
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
17578
|
-
"method": "GET",
|
|
17579
|
-
"rel": "instances",
|
|
17580
|
-
"targetSchema": {
|
|
17581
|
-
"items": {
|
|
17582
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
17583
|
-
},
|
|
17584
|
-
"type": [
|
|
17585
|
-
"array"
|
|
17586
|
-
]
|
|
17587
|
-
},
|
|
17588
|
-
"title": "List By Team - Deprecated"
|
|
17589
|
-
},
|
|
17590
|
-
{
|
|
17591
|
-
"deactivate_on": "2021-02-05",
|
|
17592
|
-
"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.",
|
|
17593
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
17594
|
-
"method": "POST",
|
|
17595
|
-
"rel": "create",
|
|
17596
|
-
"schema": {
|
|
17597
|
-
"type": [
|
|
17598
|
-
"object"
|
|
17599
|
-
],
|
|
17600
|
-
"properties": {
|
|
17601
|
-
"addon_service": {
|
|
17602
|
-
"description": "name of the Add-on to whitelist",
|
|
17603
|
-
"example": "heroku-postgresql",
|
|
17604
|
-
"type": [
|
|
17605
|
-
"string"
|
|
17606
|
-
]
|
|
17607
|
-
}
|
|
17608
|
-
}
|
|
17609
|
-
},
|
|
17610
|
-
"targetSchema": {
|
|
17611
|
-
"items": {
|
|
17612
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
17613
|
-
},
|
|
17614
|
-
"type": [
|
|
17615
|
-
"array"
|
|
17616
|
-
]
|
|
17617
|
-
},
|
|
17618
|
-
"title": "Create By Team - Deprecated"
|
|
17619
|
-
},
|
|
17620
|
-
{
|
|
17621
|
-
"deactivate_on": "2021-02-05",
|
|
17622
|
-
"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.",
|
|
17623
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services/{(%23%2Fdefinitions%2Fwhitelisted-add-on-service%2Fdefinitions%2Fidentity)}",
|
|
17624
|
-
"method": "DELETE",
|
|
17625
|
-
"rel": "destroy",
|
|
17626
|
-
"targetSchema": {
|
|
17627
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
17628
|
-
},
|
|
17629
|
-
"title": "Delete By Team - Deprecated"
|
|
17630
|
-
}
|
|
17631
|
-
],
|
|
17632
|
-
"properties": {
|
|
17633
|
-
"added_at": {
|
|
17634
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/added_at"
|
|
17635
|
-
},
|
|
17636
|
-
"added_by": {
|
|
17637
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/added_by"
|
|
17638
|
-
},
|
|
17639
|
-
"addon_service": {
|
|
17640
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/addon_service"
|
|
17641
|
-
},
|
|
17642
|
-
"id": {
|
|
17643
|
-
"$ref": "#/definitions/whitelisted-add-on-service/definitions/id"
|
|
17644
|
-
}
|
|
17645
|
-
}
|
|
17646
17351
|
}
|
|
17647
17352
|
},
|
|
17648
17353
|
"properties": {
|
|
@@ -17688,9 +17393,6 @@
|
|
|
17688
17393
|
"app-feature": {
|
|
17689
17394
|
"$ref": "#/definitions/app-feature"
|
|
17690
17395
|
},
|
|
17691
|
-
"app-formation-set": {
|
|
17692
|
-
"$ref": "#/definitions/app-formation-set"
|
|
17693
|
-
},
|
|
17694
17396
|
"app-setup": {
|
|
17695
17397
|
"$ref": "#/definitions/app-setup"
|
|
17696
17398
|
},
|
|
@@ -17739,14 +17441,14 @@
|
|
|
17739
17441
|
"dyno": {
|
|
17740
17442
|
"$ref": "#/definitions/dyno"
|
|
17741
17443
|
},
|
|
17444
|
+
"enterprise-account-daily-usage": {
|
|
17445
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
|
17446
|
+
},
|
|
17742
17447
|
"enterprise-account-member": {
|
|
17743
17448
|
"$ref": "#/definitions/enterprise-account-member"
|
|
17744
17449
|
},
|
|
17745
|
-
"enterprise-account-usage
|
|
17746
|
-
"$ref": "#/definitions/enterprise-account-usage
|
|
17747
|
-
},
|
|
17748
|
-
"enterprise-account-usage-monthly": {
|
|
17749
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly"
|
|
17450
|
+
"enterprise-account-monthly-usage": {
|
|
17451
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
|
17750
17452
|
},
|
|
17751
17453
|
"enterprise-account": {
|
|
17752
17454
|
"$ref": "#/definitions/enterprise-account"
|
|
@@ -17880,9 +17582,6 @@
|
|
|
17880
17582
|
"space": {
|
|
17881
17583
|
"$ref": "#/definitions/space"
|
|
17882
17584
|
},
|
|
17883
|
-
"ssl-endpoint": {
|
|
17884
|
-
"$ref": "#/definitions/ssl-endpoint"
|
|
17885
|
-
},
|
|
17886
17585
|
"stack": {
|
|
17887
17586
|
"$ref": "#/definitions/stack"
|
|
17888
17587
|
},
|
|
@@ -17898,6 +17597,9 @@
|
|
|
17898
17597
|
"team-app": {
|
|
17899
17598
|
"$ref": "#/definitions/team-app"
|
|
17900
17599
|
},
|
|
17600
|
+
"team-daily-usage": {
|
|
17601
|
+
"$ref": "#/definitions/team-daily-usage"
|
|
17602
|
+
},
|
|
17901
17603
|
"team-feature": {
|
|
17902
17604
|
"$ref": "#/definitions/team-feature"
|
|
17903
17605
|
},
|
|
@@ -17910,18 +17612,15 @@
|
|
|
17910
17612
|
"team-member": {
|
|
17911
17613
|
"$ref": "#/definitions/team-member"
|
|
17912
17614
|
},
|
|
17615
|
+
"team-monthly-usage": {
|
|
17616
|
+
"$ref": "#/definitions/team-monthly-usage"
|
|
17617
|
+
},
|
|
17913
17618
|
"team-preferences": {
|
|
17914
17619
|
"$ref": "#/definitions/team-preferences"
|
|
17915
17620
|
},
|
|
17916
17621
|
"team-space": {
|
|
17917
17622
|
"$ref": "#/definitions/team-space"
|
|
17918
17623
|
},
|
|
17919
|
-
"team-usage-daily": {
|
|
17920
|
-
"$ref": "#/definitions/team-usage-daily"
|
|
17921
|
-
},
|
|
17922
|
-
"team-usage-monthly": {
|
|
17923
|
-
"$ref": "#/definitions/team-usage-monthly"
|
|
17924
|
-
},
|
|
17925
17624
|
"team": {
|
|
17926
17625
|
"$ref": "#/definitions/team"
|
|
17927
17626
|
},
|
|
@@ -17939,9 +17638,6 @@
|
|
|
17939
17638
|
},
|
|
17940
17639
|
"vpn-connection": {
|
|
17941
17640
|
"$ref": "#/definitions/vpn-connection"
|
|
17942
|
-
},
|
|
17943
|
-
"whitelisted-add-on-service": {
|
|
17944
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
17945
17641
|
}
|
|
17946
17642
|
},
|
|
17947
17643
|
"description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",
|