platform-api 3.3.0 → 3.5.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/CHANGELOG.md +8 -0
- data/CODEOWNERS +2 -0
- data/README.md +6 -6
- data/lib/platform-api/client.rb +1151 -1666
- data/lib/platform-api/version.rb +1 -1
- data/schema.json +837 -1261
- metadata +7 -6
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
|
},
|
@@ -3958,6 +3871,15 @@
|
|
3958
3871
|
},
|
3959
3872
|
"stack": {
|
3960
3873
|
"$ref": "#/definitions/stack/definitions/identity"
|
3874
|
+
},
|
3875
|
+
"feature_flags": {
|
3876
|
+
"description": "unique name of app feature",
|
3877
|
+
"type": [
|
3878
|
+
"array"
|
3879
|
+
],
|
3880
|
+
"items": {
|
3881
|
+
"$ref": "#/definitions/app-feature/definitions/name"
|
3882
|
+
}
|
3961
3883
|
}
|
3962
3884
|
},
|
3963
3885
|
"type": [
|
@@ -4524,7 +4446,7 @@
|
|
4524
4446
|
},
|
4525
4447
|
"links": [
|
4526
4448
|
{
|
4527
|
-
"description": "List existing events. Returns all events for one
|
4449
|
+
"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
4450
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
|
4529
4451
|
"method": "GET",
|
4530
4452
|
"rel": "instances",
|
@@ -5539,30 +5461,6 @@
|
|
5539
5461
|
}
|
5540
5462
|
},
|
5541
5463
|
"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
5464
|
{
|
5567
5465
|
"description": "Create a new domain.",
|
5568
5466
|
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains",
|
@@ -6174,6 +6072,204 @@
|
|
6174
6072
|
}
|
6175
6073
|
}
|
6176
6074
|
},
|
6075
|
+
"enterprise-account-daily-usage": {
|
6076
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
6077
|
+
"description": "Usage for an enterprise account at a daily resolution.",
|
6078
|
+
"stability": "development",
|
6079
|
+
"strictProperties": true,
|
6080
|
+
"title": "Heroku Platform API - Enterprise Account Daily Usage",
|
6081
|
+
"type": [
|
6082
|
+
"object"
|
6083
|
+
],
|
6084
|
+
"definitions": {
|
6085
|
+
"addons": {
|
6086
|
+
"description": "total add-on credits used",
|
6087
|
+
"example": 250.0,
|
6088
|
+
"readOnly": true,
|
6089
|
+
"type": [
|
6090
|
+
"number"
|
6091
|
+
]
|
6092
|
+
},
|
6093
|
+
"data": {
|
6094
|
+
"description": "total add-on credits used for first party add-ons",
|
6095
|
+
"example": 34.89,
|
6096
|
+
"readOnly": true,
|
6097
|
+
"type": [
|
6098
|
+
"number"
|
6099
|
+
]
|
6100
|
+
},
|
6101
|
+
"date": {
|
6102
|
+
"description": "date of the usage",
|
6103
|
+
"example": "2019-01-01",
|
6104
|
+
"format": "date",
|
6105
|
+
"readOnly": true,
|
6106
|
+
"type": [
|
6107
|
+
"string"
|
6108
|
+
]
|
6109
|
+
},
|
6110
|
+
"dynos": {
|
6111
|
+
"description": "dynos used",
|
6112
|
+
"example": 1.548,
|
6113
|
+
"readOnly": true,
|
6114
|
+
"type": [
|
6115
|
+
"number"
|
6116
|
+
]
|
6117
|
+
},
|
6118
|
+
"id": {
|
6119
|
+
"description": "enterprise account identifier",
|
6120
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
6121
|
+
"format": "uuid",
|
6122
|
+
"readOnly": true,
|
6123
|
+
"type": [
|
6124
|
+
"string"
|
6125
|
+
]
|
6126
|
+
},
|
6127
|
+
"name": {
|
6128
|
+
"description": "name of the enterprise account",
|
6129
|
+
"example": "example-co",
|
6130
|
+
"readOnly": true,
|
6131
|
+
"type": [
|
6132
|
+
"string"
|
6133
|
+
]
|
6134
|
+
},
|
6135
|
+
"partner": {
|
6136
|
+
"description": "total add-on credits used for third party add-ons",
|
6137
|
+
"example": 12.34,
|
6138
|
+
"readOnly": true,
|
6139
|
+
"type": [
|
6140
|
+
"number"
|
6141
|
+
]
|
6142
|
+
},
|
6143
|
+
"space": {
|
6144
|
+
"description": "space credits used",
|
6145
|
+
"example": 1.548,
|
6146
|
+
"readOnly": true,
|
6147
|
+
"type": [
|
6148
|
+
"number"
|
6149
|
+
]
|
6150
|
+
},
|
6151
|
+
"start_date": {
|
6152
|
+
"description": "range start date",
|
6153
|
+
"example": "2019-01-25",
|
6154
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
6155
|
+
"readOnly": true,
|
6156
|
+
"type": [
|
6157
|
+
"string"
|
6158
|
+
]
|
6159
|
+
},
|
6160
|
+
"end_date": {
|
6161
|
+
"description": "range end date",
|
6162
|
+
"example": "2019-02-25",
|
6163
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
6164
|
+
"readOnly": true,
|
6165
|
+
"type": [
|
6166
|
+
"string"
|
6167
|
+
]
|
6168
|
+
}
|
6169
|
+
},
|
6170
|
+
"links": [
|
6171
|
+
{
|
6172
|
+
"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",
|
6173
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/daily",
|
6174
|
+
"method": "GET",
|
6175
|
+
"rel": "instances",
|
6176
|
+
"title": "Info",
|
6177
|
+
"schema": {
|
6178
|
+
"properties": {
|
6179
|
+
"start": {
|
6180
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/start_date"
|
6181
|
+
},
|
6182
|
+
"end": {
|
6183
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/end_date"
|
6184
|
+
}
|
6185
|
+
},
|
6186
|
+
"required": [
|
6187
|
+
"start"
|
6188
|
+
],
|
6189
|
+
"type": [
|
6190
|
+
"object"
|
6191
|
+
]
|
6192
|
+
},
|
6193
|
+
"targetSchema": {
|
6194
|
+
"items": {
|
6195
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
6196
|
+
},
|
6197
|
+
"type": [
|
6198
|
+
"array"
|
6199
|
+
]
|
6200
|
+
}
|
6201
|
+
}
|
6202
|
+
],
|
6203
|
+
"properties": {
|
6204
|
+
"addons": {
|
6205
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/addons"
|
6206
|
+
},
|
6207
|
+
"teams": {
|
6208
|
+
"description": "usage by team",
|
6209
|
+
"type": [
|
6210
|
+
"array"
|
6211
|
+
],
|
6212
|
+
"items": {
|
6213
|
+
"type": [
|
6214
|
+
"object"
|
6215
|
+
],
|
6216
|
+
"properties": {
|
6217
|
+
"addons": {
|
6218
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
6219
|
+
},
|
6220
|
+
"apps": {
|
6221
|
+
"description": "app usage in the team",
|
6222
|
+
"type": [
|
6223
|
+
"array"
|
6224
|
+
],
|
6225
|
+
"items": {
|
6226
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
6227
|
+
}
|
6228
|
+
},
|
6229
|
+
"data": {
|
6230
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
6231
|
+
},
|
6232
|
+
"dynos": {
|
6233
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
6234
|
+
},
|
6235
|
+
"id": {
|
6236
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
6237
|
+
},
|
6238
|
+
"name": {
|
6239
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
6240
|
+
},
|
6241
|
+
"partner": {
|
6242
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
6243
|
+
},
|
6244
|
+
"space": {
|
6245
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
6246
|
+
}
|
6247
|
+
}
|
6248
|
+
}
|
6249
|
+
},
|
6250
|
+
"data": {
|
6251
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/data"
|
6252
|
+
},
|
6253
|
+
"date": {
|
6254
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/date"
|
6255
|
+
},
|
6256
|
+
"dynos": {
|
6257
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/dynos"
|
6258
|
+
},
|
6259
|
+
"id": {
|
6260
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/id"
|
6261
|
+
},
|
6262
|
+
"name": {
|
6263
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/name"
|
6264
|
+
},
|
6265
|
+
"partner": {
|
6266
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/partner"
|
6267
|
+
},
|
6268
|
+
"space": {
|
6269
|
+
"$ref": "#/definitions/enterprise-account-daily-usage/definitions/space"
|
6270
|
+
}
|
6271
|
+
}
|
6272
|
+
},
|
6177
6273
|
"enterprise-account-member": {
|
6178
6274
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
6179
6275
|
"description": "Enterprise account members are users with access to an enterprise account.",
|
@@ -6427,173 +6523,9 @@
|
|
6427
6523
|
}
|
6428
6524
|
}
|
6429
6525
|
},
|
6430
|
-
"enterprise-account-usage
|
6526
|
+
"enterprise-account-monthly-usage": {
|
6431
6527
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
6432
|
-
"description": "Usage for an enterprise account at a
|
6433
|
-
"stability": "development",
|
6434
|
-
"strictProperties": true,
|
6435
|
-
"title": "Heroku Platform API - Enterprise Account Daily Usage",
|
6436
|
-
"type": [
|
6437
|
-
"object"
|
6438
|
-
],
|
6439
|
-
"definitions": {
|
6440
|
-
"addons": {
|
6441
|
-
"description": "total add-on credits used",
|
6442
|
-
"example": 250.0,
|
6443
|
-
"readOnly": true,
|
6444
|
-
"type": [
|
6445
|
-
"number"
|
6446
|
-
]
|
6447
|
-
},
|
6448
|
-
"data": {
|
6449
|
-
"description": "total add-on credits used for first party add-ons",
|
6450
|
-
"example": 34.89,
|
6451
|
-
"readOnly": true,
|
6452
|
-
"type": [
|
6453
|
-
"number"
|
6454
|
-
]
|
6455
|
-
},
|
6456
|
-
"date": {
|
6457
|
-
"description": "date of the usage",
|
6458
|
-
"example": "2019-01-01",
|
6459
|
-
"format": "date",
|
6460
|
-
"readOnly": true,
|
6461
|
-
"type": [
|
6462
|
-
"string"
|
6463
|
-
]
|
6464
|
-
},
|
6465
|
-
"dynos": {
|
6466
|
-
"description": "dynos used",
|
6467
|
-
"example": 1.548,
|
6468
|
-
"readOnly": true,
|
6469
|
-
"type": [
|
6470
|
-
"number"
|
6471
|
-
]
|
6472
|
-
},
|
6473
|
-
"id": {
|
6474
|
-
"description": "enterprise account identifier",
|
6475
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
6476
|
-
"format": "uuid",
|
6477
|
-
"readOnly": true,
|
6478
|
-
"type": [
|
6479
|
-
"string"
|
6480
|
-
]
|
6481
|
-
},
|
6482
|
-
"name": {
|
6483
|
-
"description": "name of the enterprise account",
|
6484
|
-
"example": "example-co",
|
6485
|
-
"readOnly": true,
|
6486
|
-
"type": [
|
6487
|
-
"string"
|
6488
|
-
]
|
6489
|
-
},
|
6490
|
-
"partner": {
|
6491
|
-
"description": "total add-on credits used for third party add-ons",
|
6492
|
-
"example": 12.34,
|
6493
|
-
"readOnly": true,
|
6494
|
-
"type": [
|
6495
|
-
"number"
|
6496
|
-
]
|
6497
|
-
},
|
6498
|
-
"space": {
|
6499
|
-
"description": "space credits used",
|
6500
|
-
"example": 1.548,
|
6501
|
-
"readOnly": true,
|
6502
|
-
"type": [
|
6503
|
-
"number"
|
6504
|
-
]
|
6505
|
-
}
|
6506
|
-
},
|
6507
|
-
"links": [
|
6508
|
-
{
|
6509
|
-
"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 format. For example, '/enterprise-accounts/example-account/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.",
|
6510
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/daily",
|
6511
|
-
"method": "GET",
|
6512
|
-
"rel": "instances",
|
6513
|
-
"title": "Info",
|
6514
|
-
"targetSchema": {
|
6515
|
-
"items": {
|
6516
|
-
"$ref": "#/definitions/enterprise-account-usage-daily"
|
6517
|
-
},
|
6518
|
-
"type": [
|
6519
|
-
"array"
|
6520
|
-
]
|
6521
|
-
}
|
6522
|
-
}
|
6523
|
-
],
|
6524
|
-
"properties": {
|
6525
|
-
"addons": {
|
6526
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/addons"
|
6527
|
-
},
|
6528
|
-
"teams": {
|
6529
|
-
"description": "usage by team",
|
6530
|
-
"type": [
|
6531
|
-
"array"
|
6532
|
-
],
|
6533
|
-
"items": {
|
6534
|
-
"type": [
|
6535
|
-
"object"
|
6536
|
-
],
|
6537
|
-
"properties": {
|
6538
|
-
"addons": {
|
6539
|
-
"$ref": "#/definitions/team-usage-daily/definitions/addons"
|
6540
|
-
},
|
6541
|
-
"apps": {
|
6542
|
-
"description": "app usage in the team",
|
6543
|
-
"type": [
|
6544
|
-
"array"
|
6545
|
-
],
|
6546
|
-
"items": {
|
6547
|
-
"$ref": "#/definitions/team-usage-daily/definitions/app_usage_daily"
|
6548
|
-
}
|
6549
|
-
},
|
6550
|
-
"data": {
|
6551
|
-
"$ref": "#/definitions/team-usage-daily/definitions/data"
|
6552
|
-
},
|
6553
|
-
"dynos": {
|
6554
|
-
"$ref": "#/definitions/team-usage-daily/definitions/dynos"
|
6555
|
-
},
|
6556
|
-
"id": {
|
6557
|
-
"$ref": "#/definitions/team-usage-daily/definitions/id"
|
6558
|
-
},
|
6559
|
-
"name": {
|
6560
|
-
"$ref": "#/definitions/team-usage-daily/definitions/name"
|
6561
|
-
},
|
6562
|
-
"partner": {
|
6563
|
-
"$ref": "#/definitions/team-usage-daily/definitions/partner"
|
6564
|
-
},
|
6565
|
-
"space": {
|
6566
|
-
"$ref": "#/definitions/team-usage-daily/definitions/space"
|
6567
|
-
}
|
6568
|
-
}
|
6569
|
-
}
|
6570
|
-
},
|
6571
|
-
"data": {
|
6572
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/data"
|
6573
|
-
},
|
6574
|
-
"date": {
|
6575
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/date"
|
6576
|
-
},
|
6577
|
-
"dynos": {
|
6578
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/dynos"
|
6579
|
-
},
|
6580
|
-
"id": {
|
6581
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/id"
|
6582
|
-
},
|
6583
|
-
"name": {
|
6584
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/name"
|
6585
|
-
},
|
6586
|
-
"partner": {
|
6587
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/partner"
|
6588
|
-
},
|
6589
|
-
"space": {
|
6590
|
-
"$ref": "#/definitions/enterprise-account-usage-daily/definitions/space"
|
6591
|
-
}
|
6592
|
-
}
|
6593
|
-
},
|
6594
|
-
"enterprise-account-usage-monthly": {
|
6595
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
6596
|
-
"description": "Usage for an enterprise account at a monthly resolution.",
|
6528
|
+
"description": "Usage for an enterprise account at a monthly resolution.",
|
6597
6529
|
"stability": "development",
|
6598
6530
|
"strictProperties": true,
|
6599
6531
|
"title": "Heroku Platform API - Enterprise Account Monthly Usage",
|
@@ -6674,18 +6606,52 @@
|
|
6674
6606
|
"type": [
|
6675
6607
|
"number"
|
6676
6608
|
]
|
6609
|
+
},
|
6610
|
+
"start_date": {
|
6611
|
+
"description": "range start date",
|
6612
|
+
"example": "2019-01",
|
6613
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
6614
|
+
"readOnly": true,
|
6615
|
+
"type": [
|
6616
|
+
"string"
|
6617
|
+
]
|
6618
|
+
},
|
6619
|
+
"end_date": {
|
6620
|
+
"description": "range end date",
|
6621
|
+
"example": "2019-02",
|
6622
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
6623
|
+
"readOnly": true,
|
6624
|
+
"type": [
|
6625
|
+
"string"
|
6626
|
+
]
|
6677
6627
|
}
|
6678
6628
|
},
|
6679
6629
|
"links": [
|
6680
6630
|
{
|
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
|
6631
|
+
"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",
|
6682
6632
|
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/monthly",
|
6683
6633
|
"method": "GET",
|
6684
6634
|
"rel": "instances",
|
6685
6635
|
"title": "Info",
|
6636
|
+
"schema": {
|
6637
|
+
"properties": {
|
6638
|
+
"start": {
|
6639
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/start_date"
|
6640
|
+
},
|
6641
|
+
"end": {
|
6642
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/end_date"
|
6643
|
+
}
|
6644
|
+
},
|
6645
|
+
"required": [
|
6646
|
+
"start"
|
6647
|
+
],
|
6648
|
+
"type": [
|
6649
|
+
"object"
|
6650
|
+
]
|
6651
|
+
},
|
6686
6652
|
"targetSchema": {
|
6687
6653
|
"items": {
|
6688
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6654
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
6689
6655
|
},
|
6690
6656
|
"type": [
|
6691
6657
|
"array"
|
@@ -6695,7 +6661,7 @@
|
|
6695
6661
|
],
|
6696
6662
|
"properties": {
|
6697
6663
|
"addons": {
|
6698
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6664
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/addons"
|
6699
6665
|
},
|
6700
6666
|
"teams": {
|
6701
6667
|
"description": "usage by team",
|
@@ -6708,7 +6674,7 @@
|
|
6708
6674
|
],
|
6709
6675
|
"properties": {
|
6710
6676
|
"addons": {
|
6711
|
-
"$ref": "#/definitions/team-usage
|
6677
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
6712
6678
|
},
|
6713
6679
|
"apps": {
|
6714
6680
|
"description": "app usage in the team",
|
@@ -6716,56 +6682,56 @@
|
|
6716
6682
|
"array"
|
6717
6683
|
],
|
6718
6684
|
"items": {
|
6719
|
-
"$ref": "#/definitions/team-usage
|
6685
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
6720
6686
|
}
|
6721
6687
|
},
|
6722
6688
|
"connect": {
|
6723
|
-
"$ref": "#/definitions/team-usage
|
6689
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
6724
6690
|
},
|
6725
6691
|
"data": {
|
6726
|
-
"$ref": "#/definitions/team-usage
|
6692
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
6727
6693
|
},
|
6728
6694
|
"dynos": {
|
6729
|
-
"$ref": "#/definitions/team-usage
|
6695
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
6730
6696
|
},
|
6731
6697
|
"id": {
|
6732
|
-
"$ref": "#/definitions/team-usage
|
6698
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
6733
6699
|
},
|
6734
6700
|
"name": {
|
6735
|
-
"$ref": "#/definitions/team-usage
|
6701
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
6736
6702
|
},
|
6737
6703
|
"partner": {
|
6738
|
-
"$ref": "#/definitions/team-usage
|
6704
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
6739
6705
|
},
|
6740
6706
|
"space": {
|
6741
|
-
"$ref": "#/definitions/team-usage
|
6707
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
6742
6708
|
}
|
6743
6709
|
}
|
6744
6710
|
}
|
6745
6711
|
},
|
6746
6712
|
"connect": {
|
6747
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6713
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/connect"
|
6748
6714
|
},
|
6749
6715
|
"data": {
|
6750
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6716
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/data"
|
6751
6717
|
},
|
6752
6718
|
"dynos": {
|
6753
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6719
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/dynos"
|
6754
6720
|
},
|
6755
6721
|
"id": {
|
6756
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6722
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/id"
|
6757
6723
|
},
|
6758
6724
|
"month": {
|
6759
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6725
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/month"
|
6760
6726
|
},
|
6761
6727
|
"name": {
|
6762
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6728
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/name"
|
6763
6729
|
},
|
6764
6730
|
"partner": {
|
6765
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6731
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/partner"
|
6766
6732
|
},
|
6767
6733
|
"space": {
|
6768
|
-
"$ref": "#/definitions/enterprise-account-usage
|
6734
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage/definitions/space"
|
6769
6735
|
}
|
6770
6736
|
}
|
6771
6737
|
},
|
@@ -6804,6 +6770,25 @@
|
|
6804
6770
|
}
|
6805
6771
|
]
|
6806
6772
|
},
|
6773
|
+
"identity_provider": {
|
6774
|
+
"description": "Identity Provider associated with the Enterprise Account",
|
6775
|
+
"strictProperties": true,
|
6776
|
+
"type": [
|
6777
|
+
"null",
|
6778
|
+
"object"
|
6779
|
+
],
|
6780
|
+
"properties": {
|
6781
|
+
"id": {
|
6782
|
+
"$ref": "#/definitions/identity-provider/definitions/id"
|
6783
|
+
},
|
6784
|
+
"name": {
|
6785
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
6786
|
+
},
|
6787
|
+
"owner": {
|
6788
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
6789
|
+
}
|
6790
|
+
}
|
6791
|
+
},
|
6807
6792
|
"name": {
|
6808
6793
|
"description": "unique name of the enterprise account",
|
6809
6794
|
"example": "example",
|
@@ -6906,27 +6891,7 @@
|
|
6906
6891
|
"$ref": "#/definitions/enterprise-account/definitions/trial"
|
6907
6892
|
},
|
6908
6893
|
"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
|
-
}
|
6894
|
+
"$ref": "#/definitions/enterprise-account/definitions/identity_provider"
|
6930
6895
|
}
|
6931
6896
|
}
|
6932
6897
|
},
|
@@ -7223,7 +7188,7 @@
|
|
7223
7188
|
}
|
7224
7189
|
},
|
7225
7190
|
"identity-provider": {
|
7226
|
-
"description": "Identity Providers represent the SAML configuration of an Team.",
|
7191
|
+
"description": "Identity Providers represent the SAML configuration of an Enterprise Account or Team.",
|
7227
7192
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
7228
7193
|
"stability": "production",
|
7229
7194
|
"strictProperties": true,
|
@@ -7266,6 +7231,13 @@
|
|
7266
7231
|
"string"
|
7267
7232
|
]
|
7268
7233
|
},
|
7234
|
+
"name": {
|
7235
|
+
"description": "user-friendly unique identifier for this identity provider",
|
7236
|
+
"example": "acme-sso",
|
7237
|
+
"type": [
|
7238
|
+
"string"
|
7239
|
+
]
|
7240
|
+
},
|
7269
7241
|
"slo_target_url": {
|
7270
7242
|
"description": "single log out URL for this identity provider",
|
7271
7243
|
"example": "https://example.com/idp/logout",
|
@@ -9808,7 +9780,7 @@
|
|
9808
9780
|
"links": [
|
9809
9781
|
{
|
9810
9782
|
"description": "List latest builds for each app in a pipeline",
|
9811
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
9783
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-builds",
|
9812
9784
|
"method": "GET",
|
9813
9785
|
"rel": "instances",
|
9814
9786
|
"targetSchema": {
|
@@ -10158,7 +10130,7 @@
|
|
10158
10130
|
"links": [
|
10159
10131
|
{
|
10160
10132
|
"description": "List latest slug releases for each app in a pipeline",
|
10161
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
10133
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-deployments",
|
10162
10134
|
"method": "GET",
|
10163
10135
|
"rel": "instances",
|
10164
10136
|
"targetSchema": {
|
@@ -10507,7 +10479,7 @@
|
|
10507
10479
|
"links": [
|
10508
10480
|
{
|
10509
10481
|
"description": "List latest releases for each app in a pipeline",
|
10510
|
-
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%
|
10482
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/latest-releases",
|
10511
10483
|
"method": "GET",
|
10512
10484
|
"rel": "instances",
|
10513
10485
|
"targetSchema": {
|
@@ -10534,7 +10506,7 @@
|
|
10534
10506
|
"links": [
|
10535
10507
|
{
|
10536
10508
|
"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%
|
10509
|
+
"href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/pipeline-stack",
|
10538
10510
|
"method": "GET",
|
10539
10511
|
"rel": "self",
|
10540
10512
|
"targetSchema": {
|
@@ -10843,11 +10815,11 @@
|
|
10843
10815
|
"targetSchema": {
|
10844
10816
|
"items": {
|
10845
10817
|
"$ref": "#/definitions/pipeline"
|
10846
|
-
}
|
10818
|
+
},
|
10819
|
+
"type": [
|
10820
|
+
"array"
|
10821
|
+
]
|
10847
10822
|
},
|
10848
|
-
"type": [
|
10849
|
-
"array"
|
10850
|
-
],
|
10851
10823
|
"title": "List"
|
10852
10824
|
}
|
10853
10825
|
],
|
@@ -12545,6 +12517,18 @@
|
|
12545
12517
|
"object"
|
12546
12518
|
],
|
12547
12519
|
"definitions": {
|
12520
|
+
"ca_signed?": {
|
12521
|
+
"readOnly": true,
|
12522
|
+
"type": [
|
12523
|
+
"boolean"
|
12524
|
+
]
|
12525
|
+
},
|
12526
|
+
"cert_domains": {
|
12527
|
+
"readOnly": true,
|
12528
|
+
"type": [
|
12529
|
+
"array"
|
12530
|
+
]
|
12531
|
+
},
|
12548
12532
|
"certificate_chain": {
|
12549
12533
|
"description": "raw contents of the public certificate chain (eg: .crt or .pem file)",
|
12550
12534
|
"example": "-----BEGIN CERTIFICATE----- ...",
|
@@ -12553,15 +12537,6 @@
|
|
12553
12537
|
"string"
|
12554
12538
|
]
|
12555
12539
|
},
|
12556
|
-
"cname": {
|
12557
|
-
"description": "deprecated; refer to GET /apps/:id/domains for valid CNAMEs for this app",
|
12558
|
-
"example": "example.herokussl.com",
|
12559
|
-
"readOnly": false,
|
12560
|
-
"type": [
|
12561
|
-
"string",
|
12562
|
-
"null"
|
12563
|
-
]
|
12564
|
-
},
|
12565
12540
|
"created_at": {
|
12566
12541
|
"description": "when endpoint was created",
|
12567
12542
|
"example": "2012-01-01T12:00:00Z",
|
@@ -12571,25 +12546,58 @@
|
|
12571
12546
|
"string"
|
12572
12547
|
]
|
12573
12548
|
},
|
12574
|
-
"
|
12575
|
-
"description": "
|
12576
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
12577
|
-
"format": "uuid",
|
12578
|
-
"readOnly": true,
|
12549
|
+
"domains": {
|
12550
|
+
"description": "domains associated with this SSL certificate",
|
12579
12551
|
"type": [
|
12580
|
-
"
|
12581
|
-
]
|
12552
|
+
"array"
|
12553
|
+
],
|
12554
|
+
"readOnly": true,
|
12555
|
+
"items": {
|
12556
|
+
"$ref": "#/definitions/domain/definitions/id"
|
12557
|
+
}
|
12582
12558
|
},
|
12583
|
-
"
|
12584
|
-
"
|
12585
|
-
|
12586
|
-
|
12559
|
+
"display_name": {
|
12560
|
+
"description": "unique name for SSL certificate",
|
12561
|
+
"example": "example",
|
12562
|
+
"pattern": "^[a-z][a-z0-9-]{2,29}$",
|
12563
|
+
"readOnly": false,
|
12564
|
+
"type": [
|
12565
|
+
"string",
|
12566
|
+
"null"
|
12567
|
+
]
|
12568
|
+
},
|
12569
|
+
"expires_at": {
|
12570
|
+
"readOnly": true,
|
12571
|
+
"format": "date-time",
|
12572
|
+
"type": [
|
12573
|
+
"string"
|
12574
|
+
]
|
12575
|
+
},
|
12576
|
+
"id": {
|
12577
|
+
"description": "unique identifier of this SNI endpoint",
|
12578
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
12579
|
+
"format": "uuid",
|
12580
|
+
"readOnly": true,
|
12581
|
+
"type": [
|
12582
|
+
"string"
|
12583
|
+
]
|
12584
|
+
},
|
12585
|
+
"identity": {
|
12586
|
+
"anyOf": [
|
12587
|
+
{
|
12588
|
+
"$ref": "#/definitions/sni-endpoint/definitions/id"
|
12587
12589
|
},
|
12588
12590
|
{
|
12589
12591
|
"$ref": "#/definitions/sni-endpoint/definitions/name"
|
12590
12592
|
}
|
12591
12593
|
]
|
12592
12594
|
},
|
12595
|
+
"issuer": {
|
12596
|
+
"readOnly": true,
|
12597
|
+
"type": [
|
12598
|
+
"string"
|
12599
|
+
]
|
12600
|
+
},
|
12593
12601
|
"name": {
|
12594
12602
|
"description": "unique name for SNI endpoint",
|
12595
12603
|
"example": "example",
|
@@ -12607,33 +12615,32 @@
|
|
12607
12615
|
"string"
|
12608
12616
|
]
|
12609
12617
|
},
|
12610
|
-
"
|
12611
|
-
"description": "when SNI endpoint was updated",
|
12612
|
-
"example": "2012-01-01T12:00:00Z",
|
12613
|
-
"format": "date-time",
|
12618
|
+
"self_signed?": {
|
12614
12619
|
"readOnly": true,
|
12615
12620
|
"type": [
|
12616
|
-
"
|
12621
|
+
"boolean"
|
12617
12622
|
]
|
12618
12623
|
},
|
12619
|
-
"
|
12620
|
-
"
|
12624
|
+
"starts_at": {
|
12625
|
+
"readOnly": true,
|
12626
|
+
"format": "date-time",
|
12621
12627
|
"type": [
|
12622
|
-
"
|
12623
|
-
]
|
12628
|
+
"string"
|
12629
|
+
]
|
12630
|
+
},
|
12631
|
+
"subject": {
|
12624
12632
|
"readOnly": true,
|
12625
|
-
"
|
12626
|
-
"
|
12627
|
-
|
12633
|
+
"type": [
|
12634
|
+
"string"
|
12635
|
+
]
|
12628
12636
|
},
|
12629
|
-
"
|
12630
|
-
"description": "
|
12631
|
-
"example": "
|
12632
|
-
"
|
12633
|
-
"readOnly":
|
12637
|
+
"updated_at": {
|
12638
|
+
"description": "when SNI endpoint was updated",
|
12639
|
+
"example": "2012-01-01T12:00:00Z",
|
12640
|
+
"format": "date-time",
|
12641
|
+
"readOnly": true,
|
12634
12642
|
"type": [
|
12635
|
-
"string"
|
12636
|
-
"null"
|
12643
|
+
"string"
|
12637
12644
|
]
|
12638
12645
|
}
|
12639
12646
|
},
|
@@ -12732,9 +12739,6 @@
|
|
12732
12739
|
"certificate_chain": {
|
12733
12740
|
"$ref": "#/definitions/sni-endpoint/definitions/certificate_chain"
|
12734
12741
|
},
|
12735
|
-
"cname": {
|
12736
|
-
"$ref": "#/definitions/sni-endpoint/definitions/cname"
|
12737
|
-
},
|
12738
12742
|
"created_at": {
|
12739
12743
|
"$ref": "#/definitions/sni-endpoint/definitions/created_at"
|
12740
12744
|
},
|
@@ -12775,25 +12779,25 @@
|
|
12775
12779
|
],
|
12776
12780
|
"properties": {
|
12777
12781
|
"ca_signed?": {
|
12778
|
-
"$ref": "#/definitions/
|
12782
|
+
"$ref": "#/definitions/sni-endpoint/definitions/ca_signed?"
|
12779
12783
|
},
|
12780
12784
|
"cert_domains": {
|
12781
|
-
"$ref": "#/definitions/
|
12785
|
+
"$ref": "#/definitions/sni-endpoint/definitions/cert_domains"
|
12782
12786
|
},
|
12783
12787
|
"expires_at": {
|
12784
|
-
"$ref": "#/definitions/
|
12788
|
+
"$ref": "#/definitions/sni-endpoint/definitions/expires_at"
|
12785
12789
|
},
|
12786
12790
|
"issuer": {
|
12787
|
-
"$ref": "#/definitions/
|
12791
|
+
"$ref": "#/definitions/sni-endpoint/definitions/issuer"
|
12788
12792
|
},
|
12789
12793
|
"self_signed?": {
|
12790
|
-
"$ref": "#/definitions/
|
12794
|
+
"$ref": "#/definitions/sni-endpoint/definitions/self_signed?"
|
12791
12795
|
},
|
12792
12796
|
"starts_at": {
|
12793
|
-
"$ref": "#/definitions/
|
12797
|
+
"$ref": "#/definitions/sni-endpoint/definitions/starts_at"
|
12794
12798
|
},
|
12795
12799
|
"subject": {
|
12796
|
-
"$ref": "#/definitions/
|
12800
|
+
"$ref": "#/definitions/sni-endpoint/definitions/subject"
|
12797
12801
|
},
|
12798
12802
|
"id": {
|
12799
12803
|
"description": "unique identifier of this SSL certificate",
|
@@ -13288,7 +13292,7 @@
|
|
13288
13292
|
]
|
13289
13293
|
},
|
13290
13294
|
"space": {
|
13291
|
-
"description": "A space is an isolated, highly available, secure app execution
|
13295
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
13292
13296
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
13293
13297
|
"stability": "prototype",
|
13294
13298
|
"strictProperties": true,
|
@@ -13364,6 +13368,13 @@
|
|
13364
13368
|
"string"
|
13365
13369
|
]
|
13366
13370
|
},
|
13371
|
+
"log_drain_url": {
|
13372
|
+
"description": "URL to which all apps will drain logs. Only settable during space creation and enables direct logging. Must use HTTPS.",
|
13373
|
+
"example": "https://example.com/logs",
|
13374
|
+
"type": [
|
13375
|
+
"string"
|
13376
|
+
]
|
13377
|
+
},
|
13367
13378
|
"cidr": {
|
13368
13379
|
"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
13380
|
"example": "172.20.20.30/16",
|
@@ -13463,6 +13474,9 @@
|
|
13463
13474
|
},
|
13464
13475
|
"data_cidr": {
|
13465
13476
|
"$ref": "#/definitions/space/definitions/data_cidr"
|
13477
|
+
},
|
13478
|
+
"log_drain_url": {
|
13479
|
+
"$ref": "#/definitions/space/definitions/log_drain_url"
|
13466
13480
|
}
|
13467
13481
|
},
|
13468
13482
|
"required": [
|
@@ -13546,52 +13560,18 @@
|
|
13546
13560
|
}
|
13547
13561
|
}
|
13548
13562
|
},
|
13549
|
-
"
|
13550
|
-
"description": "
|
13563
|
+
"stack": {
|
13564
|
+
"description": "Stacks are the different application execution environments available in the Heroku platform.",
|
13551
13565
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
13552
|
-
"title": "Heroku Platform API - SSL Endpoint",
|
13553
13566
|
"stability": "production",
|
13554
13567
|
"strictProperties": true,
|
13568
|
+
"title": "Heroku Platform API - Stack",
|
13555
13569
|
"type": [
|
13556
13570
|
"object"
|
13557
13571
|
],
|
13558
13572
|
"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
13573
|
"created_at": {
|
13594
|
-
"description": "when
|
13574
|
+
"description": "when stack was introduced",
|
13595
13575
|
"example": "2012-01-01T12:00:00Z",
|
13596
13576
|
"format": "date-time",
|
13597
13577
|
"readOnly": true,
|
@@ -13599,25 +13579,16 @@
|
|
13599
13579
|
"string"
|
13600
13580
|
]
|
13601
13581
|
},
|
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": {
|
13582
|
+
"default": {
|
13583
|
+
"description": "indicates this stack is the default for new apps",
|
13584
|
+
"example": true,
|
13613
13585
|
"readOnly": true,
|
13614
|
-
"format": "date-time",
|
13615
13586
|
"type": [
|
13616
|
-
"
|
13587
|
+
"boolean"
|
13617
13588
|
]
|
13618
13589
|
},
|
13619
13590
|
"id": {
|
13620
|
-
"description": "unique identifier of
|
13591
|
+
"description": "unique identifier of stack",
|
13621
13592
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
13622
13593
|
"format": "uuid",
|
13623
13594
|
"readOnly": true,
|
@@ -13628,66 +13599,31 @@
|
|
13628
13599
|
"identity": {
|
13629
13600
|
"anyOf": [
|
13630
13601
|
{
|
13631
|
-
"$ref": "#/definitions/
|
13602
|
+
"$ref": "#/definitions/stack/definitions/name"
|
13632
13603
|
},
|
13633
13604
|
{
|
13634
|
-
"$ref": "#/definitions/
|
13605
|
+
"$ref": "#/definitions/stack/definitions/id"
|
13635
13606
|
}
|
13636
13607
|
]
|
13637
13608
|
},
|
13638
|
-
"issuer": {
|
13639
|
-
"readOnly": true,
|
13640
|
-
"type": [
|
13641
|
-
"string"
|
13642
|
-
]
|
13643
|
-
},
|
13644
13609
|
"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": {
|
13610
|
+
"description": "unique name of stack",
|
13611
|
+
"example": "heroku-18",
|
13677
13612
|
"readOnly": true,
|
13678
|
-
"format": "date-time",
|
13679
13613
|
"type": [
|
13680
13614
|
"string"
|
13681
13615
|
]
|
13682
13616
|
},
|
13683
|
-
"
|
13617
|
+
"state": {
|
13618
|
+
"description": "availability of this stack: beta, deprecated or public",
|
13619
|
+
"example": "public",
|
13684
13620
|
"readOnly": true,
|
13685
13621
|
"type": [
|
13686
13622
|
"string"
|
13687
13623
|
]
|
13688
13624
|
},
|
13689
13625
|
"updated_at": {
|
13690
|
-
"description": "when
|
13626
|
+
"description": "when stack was last modified",
|
13691
13627
|
"example": "2012-01-01T12:00:00Z",
|
13692
13628
|
"format": "date-time",
|
13693
13629
|
"readOnly": true,
|
@@ -13698,288 +13634,37 @@
|
|
13698
13634
|
},
|
13699
13635
|
"links": [
|
13700
13636
|
{
|
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)}",
|
13637
|
+
"description": "Stack info.",
|
13638
|
+
"href": "/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}",
|
13743
13639
|
"method": "GET",
|
13744
13640
|
"rel": "self",
|
13745
13641
|
"targetSchema": {
|
13746
|
-
"$ref": "#/definitions/
|
13642
|
+
"$ref": "#/definitions/stack"
|
13747
13643
|
},
|
13748
13644
|
"title": "Info"
|
13749
13645
|
},
|
13750
13646
|
{
|
13751
|
-
"description": "List
|
13752
|
-
"href": "/
|
13647
|
+
"description": "List available stacks.",
|
13648
|
+
"href": "/stacks",
|
13753
13649
|
"method": "GET",
|
13754
13650
|
"rel": "instances",
|
13755
13651
|
"targetSchema": {
|
13756
13652
|
"items": {
|
13757
|
-
"$ref": "#/definitions/
|
13653
|
+
"$ref": "#/definitions/stack"
|
13758
13654
|
},
|
13759
13655
|
"type": [
|
13760
13656
|
"array"
|
13761
13657
|
]
|
13762
13658
|
},
|
13763
13659
|
"title": "List"
|
13764
|
-
},
|
13765
|
-
{
|
13766
|
-
"description": "Update an existing SSL endpoint.",
|
13767
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}",
|
13768
|
-
"method": "PATCH",
|
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
13660
|
}
|
13791
13661
|
],
|
13792
13662
|
"properties": {
|
13793
|
-
"
|
13794
|
-
"
|
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"
|
13663
|
+
"default": {
|
13664
|
+
"$ref": "#/definitions/stack/definitions/default"
|
13813
13665
|
},
|
13814
13666
|
"created_at": {
|
13815
|
-
"$ref": "#/definitions/
|
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"
|
13980
|
-
},
|
13981
|
-
"created_at": {
|
13982
|
-
"$ref": "#/definitions/stack/definitions/created_at"
|
13667
|
+
"$ref": "#/definitions/stack/definitions/created_at"
|
13983
13668
|
},
|
13984
13669
|
"id": {
|
13985
13670
|
"$ref": "#/definitions/stack/definitions/id"
|
@@ -14565,51 +14250,74 @@
|
|
14565
14250
|
}
|
14566
14251
|
}
|
14567
14252
|
},
|
14568
|
-
"team-
|
14569
|
-
"description": "A team feature represents a feature enabled on a team account.",
|
14253
|
+
"team-daily-usage": {
|
14570
14254
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
14255
|
+
"description": "Usage for an enterprise team at a daily resolution.",
|
14571
14256
|
"stability": "development",
|
14572
14257
|
"strictProperties": true,
|
14573
|
-
"title": "Heroku Platform API - Team
|
14258
|
+
"title": "Heroku Platform API - Team Daily Usage",
|
14574
14259
|
"type": [
|
14575
14260
|
"object"
|
14576
14261
|
],
|
14577
14262
|
"definitions": {
|
14578
|
-
"
|
14579
|
-
"description": "
|
14580
|
-
"example":
|
14581
|
-
"format": "date-time",
|
14263
|
+
"addons": {
|
14264
|
+
"description": "total add-on credits used",
|
14265
|
+
"example": 250.0,
|
14582
14266
|
"readOnly": true,
|
14583
14267
|
"type": [
|
14584
|
-
"
|
14268
|
+
"number"
|
14585
14269
|
]
|
14586
14270
|
},
|
14587
|
-
"
|
14588
|
-
"description": "
|
14589
|
-
"
|
14271
|
+
"app_usage_daily": {
|
14272
|
+
"description": "Usage for an app at a daily resolution.",
|
14273
|
+
"type": [
|
14274
|
+
"object"
|
14275
|
+
],
|
14276
|
+
"properties": {
|
14277
|
+
"addons": {
|
14278
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
14279
|
+
},
|
14280
|
+
"app_name": {
|
14281
|
+
"$ref": "#/definitions/app/definitions/name"
|
14282
|
+
},
|
14283
|
+
"data": {
|
14284
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
14285
|
+
},
|
14286
|
+
"dynos": {
|
14287
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
14288
|
+
},
|
14289
|
+
"partner": {
|
14290
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
14291
|
+
}
|
14292
|
+
}
|
14293
|
+
},
|
14294
|
+
"data": {
|
14295
|
+
"description": "total add-on credits used for first party add-ons",
|
14296
|
+
"example": 34.89,
|
14590
14297
|
"readOnly": true,
|
14591
14298
|
"type": [
|
14592
|
-
"
|
14299
|
+
"number"
|
14593
14300
|
]
|
14594
14301
|
},
|
14595
|
-
"
|
14596
|
-
"description": "
|
14597
|
-
"example": "
|
14302
|
+
"date": {
|
14303
|
+
"description": "date of the usage",
|
14304
|
+
"example": "2019-01-01",
|
14305
|
+
"format": "date",
|
14598
14306
|
"readOnly": true,
|
14599
14307
|
"type": [
|
14600
14308
|
"string"
|
14601
14309
|
]
|
14602
14310
|
},
|
14603
|
-
"
|
14604
|
-
"description": "
|
14605
|
-
"example":
|
14606
|
-
"readOnly":
|
14311
|
+
"dynos": {
|
14312
|
+
"description": "dynos used",
|
14313
|
+
"example": 1.548,
|
14314
|
+
"readOnly": true,
|
14607
14315
|
"type": [
|
14608
|
-
"
|
14316
|
+
"number"
|
14609
14317
|
]
|
14610
14318
|
},
|
14611
14319
|
"id": {
|
14612
|
-
"description": "
|
14320
|
+
"description": "team identifier",
|
14613
14321
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
14614
14322
|
"format": "uuid",
|
14615
14323
|
"readOnly": true,
|
@@ -14617,52 +14325,43 @@
|
|
14617
14325
|
"string"
|
14618
14326
|
]
|
14619
14327
|
},
|
14620
|
-
"identity": {
|
14621
|
-
"anyOf": [
|
14622
|
-
{
|
14623
|
-
"$ref": "#/definitions/team-feature/definitions/id"
|
14624
|
-
},
|
14625
|
-
{
|
14626
|
-
"$ref": "#/definitions/team-feature/definitions/name"
|
14627
|
-
}
|
14628
|
-
]
|
14629
|
-
},
|
14630
14328
|
"name": {
|
14631
|
-
"description": "
|
14632
|
-
"example": "
|
14329
|
+
"description": "name of the team",
|
14330
|
+
"example": "ops",
|
14633
14331
|
"readOnly": true,
|
14634
14332
|
"type": [
|
14635
14333
|
"string"
|
14636
14334
|
]
|
14637
14335
|
},
|
14638
|
-
"
|
14639
|
-
"description": "
|
14640
|
-
"example":
|
14336
|
+
"partner": {
|
14337
|
+
"description": "total add-on credits used for third party add-ons",
|
14338
|
+
"example": 12.34,
|
14641
14339
|
"readOnly": true,
|
14642
14340
|
"type": [
|
14643
|
-
"
|
14341
|
+
"number"
|
14644
14342
|
]
|
14645
14343
|
},
|
14646
|
-
"
|
14647
|
-
"description": "
|
14648
|
-
"example":
|
14649
|
-
"format": "date-time",
|
14344
|
+
"space": {
|
14345
|
+
"description": "space credits used",
|
14346
|
+
"example": 1.548,
|
14650
14347
|
"readOnly": true,
|
14651
14348
|
"type": [
|
14652
|
-
"
|
14349
|
+
"number"
|
14653
14350
|
]
|
14654
14351
|
},
|
14655
|
-
"
|
14656
|
-
"description": "
|
14657
|
-
"example": "
|
14352
|
+
"start_date": {
|
14353
|
+
"description": "range start date",
|
14354
|
+
"example": "2019-01-25",
|
14355
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
14658
14356
|
"readOnly": true,
|
14659
14357
|
"type": [
|
14660
14358
|
"string"
|
14661
14359
|
]
|
14662
14360
|
},
|
14663
|
-
"
|
14664
|
-
"description": "
|
14665
|
-
"example": "
|
14361
|
+
"end_date": {
|
14362
|
+
"description": "range end date",
|
14363
|
+
"example": "2019-02-25",
|
14364
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
14666
14365
|
"readOnly": true,
|
14667
14366
|
"type": [
|
14668
14367
|
"string"
|
@@ -14671,11 +14370,184 @@
|
|
14671
14370
|
},
|
14672
14371
|
"links": [
|
14673
14372
|
{
|
14674
|
-
"description": "
|
14675
|
-
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%
|
14373
|
+
"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",
|
14374
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
|
14676
14375
|
"method": "GET",
|
14677
|
-
"
|
14678
|
-
"
|
14376
|
+
"title": "Info",
|
14377
|
+
"schema": {
|
14378
|
+
"properties": {
|
14379
|
+
"start": {
|
14380
|
+
"$ref": "#/definitions/team-daily-usage/definitions/start_date"
|
14381
|
+
},
|
14382
|
+
"end": {
|
14383
|
+
"$ref": "#/definitions/team-daily-usage/definitions/end_date"
|
14384
|
+
}
|
14385
|
+
},
|
14386
|
+
"required": [
|
14387
|
+
"start"
|
14388
|
+
],
|
14389
|
+
"type": [
|
14390
|
+
"object"
|
14391
|
+
]
|
14392
|
+
},
|
14393
|
+
"rel": "instances",
|
14394
|
+
"targetSchema": {
|
14395
|
+
"items": {
|
14396
|
+
"$ref": "#/definitions/team-daily-usage"
|
14397
|
+
},
|
14398
|
+
"type": [
|
14399
|
+
"array"
|
14400
|
+
]
|
14401
|
+
}
|
14402
|
+
}
|
14403
|
+
],
|
14404
|
+
"properties": {
|
14405
|
+
"addons": {
|
14406
|
+
"$ref": "#/definitions/team-daily-usage/definitions/addons"
|
14407
|
+
},
|
14408
|
+
"apps": {
|
14409
|
+
"description": "app usage in the team",
|
14410
|
+
"type": [
|
14411
|
+
"array"
|
14412
|
+
],
|
14413
|
+
"items": {
|
14414
|
+
"$ref": "#/definitions/team-daily-usage/definitions/app_usage_daily"
|
14415
|
+
}
|
14416
|
+
},
|
14417
|
+
"data": {
|
14418
|
+
"$ref": "#/definitions/team-daily-usage/definitions/data"
|
14419
|
+
},
|
14420
|
+
"date": {
|
14421
|
+
"$ref": "#/definitions/team-daily-usage/definitions/date"
|
14422
|
+
},
|
14423
|
+
"dynos": {
|
14424
|
+
"$ref": "#/definitions/team-daily-usage/definitions/dynos"
|
14425
|
+
},
|
14426
|
+
"id": {
|
14427
|
+
"$ref": "#/definitions/team-daily-usage/definitions/id"
|
14428
|
+
},
|
14429
|
+
"name": {
|
14430
|
+
"$ref": "#/definitions/team-daily-usage/definitions/name"
|
14431
|
+
},
|
14432
|
+
"partner": {
|
14433
|
+
"$ref": "#/definitions/team-daily-usage/definitions/partner"
|
14434
|
+
},
|
14435
|
+
"space": {
|
14436
|
+
"$ref": "#/definitions/team-daily-usage/definitions/space"
|
14437
|
+
}
|
14438
|
+
}
|
14439
|
+
},
|
14440
|
+
"team-feature": {
|
14441
|
+
"description": "A team feature represents a feature enabled on a team account.",
|
14442
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
14443
|
+
"stability": "development",
|
14444
|
+
"strictProperties": true,
|
14445
|
+
"title": "Heroku Platform API - Team Feature",
|
14446
|
+
"type": [
|
14447
|
+
"object"
|
14448
|
+
],
|
14449
|
+
"definitions": {
|
14450
|
+
"created_at": {
|
14451
|
+
"description": "when team feature was created",
|
14452
|
+
"example": "2012-01-01T12:00:00Z",
|
14453
|
+
"format": "date-time",
|
14454
|
+
"readOnly": true,
|
14455
|
+
"type": [
|
14456
|
+
"string"
|
14457
|
+
]
|
14458
|
+
},
|
14459
|
+
"description": {
|
14460
|
+
"description": "description of team feature",
|
14461
|
+
"example": "Causes account to example.",
|
14462
|
+
"readOnly": true,
|
14463
|
+
"type": [
|
14464
|
+
"string"
|
14465
|
+
]
|
14466
|
+
},
|
14467
|
+
"doc_url": {
|
14468
|
+
"description": "documentation URL of team feature",
|
14469
|
+
"example": "http://devcenter.heroku.com/articles/example",
|
14470
|
+
"readOnly": true,
|
14471
|
+
"type": [
|
14472
|
+
"string"
|
14473
|
+
]
|
14474
|
+
},
|
14475
|
+
"enabled": {
|
14476
|
+
"description": "whether or not team feature has been enabled",
|
14477
|
+
"example": true,
|
14478
|
+
"readOnly": false,
|
14479
|
+
"type": [
|
14480
|
+
"boolean"
|
14481
|
+
]
|
14482
|
+
},
|
14483
|
+
"id": {
|
14484
|
+
"description": "unique identifier of team feature",
|
14485
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
14486
|
+
"format": "uuid",
|
14487
|
+
"readOnly": true,
|
14488
|
+
"type": [
|
14489
|
+
"string"
|
14490
|
+
]
|
14491
|
+
},
|
14492
|
+
"identity": {
|
14493
|
+
"anyOf": [
|
14494
|
+
{
|
14495
|
+
"$ref": "#/definitions/team-feature/definitions/id"
|
14496
|
+
},
|
14497
|
+
{
|
14498
|
+
"$ref": "#/definitions/team-feature/definitions/name"
|
14499
|
+
}
|
14500
|
+
]
|
14501
|
+
},
|
14502
|
+
"name": {
|
14503
|
+
"description": "unique name of team feature",
|
14504
|
+
"example": "name",
|
14505
|
+
"readOnly": true,
|
14506
|
+
"type": [
|
14507
|
+
"string"
|
14508
|
+
]
|
14509
|
+
},
|
14510
|
+
"state": {
|
14511
|
+
"description": "state of team feature",
|
14512
|
+
"example": "public",
|
14513
|
+
"readOnly": true,
|
14514
|
+
"type": [
|
14515
|
+
"string"
|
14516
|
+
]
|
14517
|
+
},
|
14518
|
+
"updated_at": {
|
14519
|
+
"description": "when team feature was updated",
|
14520
|
+
"example": "2012-01-01T12:00:00Z",
|
14521
|
+
"format": "date-time",
|
14522
|
+
"readOnly": true,
|
14523
|
+
"type": [
|
14524
|
+
"string"
|
14525
|
+
]
|
14526
|
+
},
|
14527
|
+
"display_name": {
|
14528
|
+
"description": "user readable feature name",
|
14529
|
+
"example": "My Feature",
|
14530
|
+
"readOnly": true,
|
14531
|
+
"type": [
|
14532
|
+
"string"
|
14533
|
+
]
|
14534
|
+
},
|
14535
|
+
"feedback_email": {
|
14536
|
+
"description": "e-mail to send feedback about the feature",
|
14537
|
+
"example": "feedback@heroku.com",
|
14538
|
+
"readOnly": true,
|
14539
|
+
"type": [
|
14540
|
+
"string"
|
14541
|
+
]
|
14542
|
+
}
|
14543
|
+
},
|
14544
|
+
"links": [
|
14545
|
+
{
|
14546
|
+
"description": "Info for an existing team feature.",
|
14547
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Fteam-feature%2Fdefinitions%2Fidentity)}",
|
14548
|
+
"method": "GET",
|
14549
|
+
"rel": "self",
|
14550
|
+
"targetSchema": {
|
14679
14551
|
"$ref": "#/definitions/team-feature"
|
14680
14552
|
},
|
14681
14553
|
"title": "Info"
|
@@ -15447,282 +15319,7 @@
|
|
15447
15319
|
}
|
15448
15320
|
}
|
15449
15321
|
},
|
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": {
|
15322
|
+
"team-monthly-usage": {
|
15726
15323
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
15727
15324
|
"description": "Usage for an enterprise team at a monthly resolution.",
|
15728
15325
|
"stability": "development",
|
@@ -15747,19 +15344,19 @@
|
|
15747
15344
|
],
|
15748
15345
|
"properties": {
|
15749
15346
|
"addons": {
|
15750
|
-
"$ref": "#/definitions/team-usage
|
15347
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
15751
15348
|
},
|
15752
15349
|
"app_name": {
|
15753
15350
|
"$ref": "#/definitions/app/definitions/name"
|
15754
15351
|
},
|
15755
15352
|
"data": {
|
15756
|
-
"$ref": "#/definitions/team-usage
|
15353
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
15757
15354
|
},
|
15758
15355
|
"dynos": {
|
15759
|
-
"$ref": "#/definitions/team-usage
|
15356
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
15760
15357
|
},
|
15761
15358
|
"partner": {
|
15762
|
-
"$ref": "#/definitions/team-usage
|
15359
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
15763
15360
|
}
|
15764
15361
|
}
|
15765
15362
|
},
|
@@ -15828,18 +15425,52 @@
|
|
15828
15425
|
"type": [
|
15829
15426
|
"number"
|
15830
15427
|
]
|
15428
|
+
},
|
15429
|
+
"start_date": {
|
15430
|
+
"description": "range start date",
|
15431
|
+
"example": "2019-01",
|
15432
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
15433
|
+
"readOnly": true,
|
15434
|
+
"type": [
|
15435
|
+
"string"
|
15436
|
+
]
|
15437
|
+
},
|
15438
|
+
"end_date": {
|
15439
|
+
"description": "range end date",
|
15440
|
+
"example": "2019-02",
|
15441
|
+
"pattern": "^[0-9]{4}-[0-9]{2}$",
|
15442
|
+
"readOnly": true,
|
15443
|
+
"type": [
|
15444
|
+
"string"
|
15445
|
+
]
|
15831
15446
|
}
|
15832
15447
|
},
|
15833
15448
|
"links": [
|
15834
15449
|
{
|
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
|
15450
|
+
"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
15451
|
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/monthly",
|
15837
15452
|
"method": "GET",
|
15838
15453
|
"title": "Info",
|
15454
|
+
"schema": {
|
15455
|
+
"properties": {
|
15456
|
+
"start": {
|
15457
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/start_date"
|
15458
|
+
},
|
15459
|
+
"end": {
|
15460
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/end_date"
|
15461
|
+
}
|
15462
|
+
},
|
15463
|
+
"required": [
|
15464
|
+
"start"
|
15465
|
+
],
|
15466
|
+
"type": [
|
15467
|
+
"object"
|
15468
|
+
]
|
15469
|
+
},
|
15839
15470
|
"rel": "instances",
|
15840
15471
|
"targetSchema": {
|
15841
15472
|
"items": {
|
15842
|
-
"$ref": "#/definitions/team-usage
|
15473
|
+
"$ref": "#/definitions/team-monthly-usage"
|
15843
15474
|
},
|
15844
15475
|
"type": [
|
15845
15476
|
"array"
|
@@ -15849,7 +15480,7 @@
|
|
15849
15480
|
],
|
15850
15481
|
"properties": {
|
15851
15482
|
"addons": {
|
15852
|
-
"$ref": "#/definitions/team-usage
|
15483
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/addons"
|
15853
15484
|
},
|
15854
15485
|
"apps": {
|
15855
15486
|
"description": "app usage in the team",
|
@@ -15857,35 +15488,141 @@
|
|
15857
15488
|
"array"
|
15858
15489
|
],
|
15859
15490
|
"items": {
|
15860
|
-
"$ref": "#/definitions/team-usage
|
15491
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/app_usage_monthly"
|
15861
15492
|
}
|
15862
15493
|
},
|
15863
15494
|
"connect": {
|
15864
|
-
"$ref": "#/definitions/team-usage
|
15495
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/connect"
|
15865
15496
|
},
|
15866
15497
|
"data": {
|
15867
|
-
"$ref": "#/definitions/team-usage
|
15498
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/data"
|
15868
15499
|
},
|
15869
15500
|
"dynos": {
|
15870
|
-
"$ref": "#/definitions/team-usage
|
15501
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/dynos"
|
15871
15502
|
},
|
15872
15503
|
"id": {
|
15873
|
-
"$ref": "#/definitions/team-usage
|
15504
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/id"
|
15874
15505
|
},
|
15875
15506
|
"month": {
|
15876
|
-
"$ref": "#/definitions/team-usage
|
15507
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/month"
|
15877
15508
|
},
|
15878
15509
|
"name": {
|
15879
|
-
"$ref": "#/definitions/team-usage
|
15510
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/name"
|
15880
15511
|
},
|
15881
15512
|
"partner": {
|
15882
|
-
"$ref": "#/definitions/team-usage
|
15513
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/partner"
|
15883
15514
|
},
|
15884
15515
|
"space": {
|
15885
|
-
"$ref": "#/definitions/team-usage
|
15516
|
+
"$ref": "#/definitions/team-monthly-usage/definitions/space"
|
15517
|
+
}
|
15518
|
+
}
|
15519
|
+
},
|
15520
|
+
"team-preferences": {
|
15521
|
+
"description": "Tracks a Team's Preferences",
|
15522
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
15523
|
+
"stability": "development",
|
15524
|
+
"strictProperties": true,
|
15525
|
+
"title": "Heroku Platform API - Team Preferences",
|
15526
|
+
"type": [
|
15527
|
+
"object"
|
15528
|
+
],
|
15529
|
+
"definitions": {
|
15530
|
+
"default-permission": {
|
15531
|
+
"description": "The default permission used when adding new members to the team",
|
15532
|
+
"example": "member",
|
15533
|
+
"readOnly": false,
|
15534
|
+
"enum": [
|
15535
|
+
"admin",
|
15536
|
+
"member",
|
15537
|
+
"viewer",
|
15538
|
+
null
|
15539
|
+
],
|
15540
|
+
"type": [
|
15541
|
+
"null",
|
15542
|
+
"string"
|
15543
|
+
]
|
15544
|
+
},
|
15545
|
+
"identity": {
|
15546
|
+
"$ref": "#/definitions/team/definitions/identity"
|
15547
|
+
},
|
15548
|
+
"addons-controls": {
|
15549
|
+
"description": "Whether add-on service rules should be applied to add-on installations",
|
15550
|
+
"example": true,
|
15551
|
+
"readOnly": false,
|
15552
|
+
"type": [
|
15553
|
+
"boolean",
|
15554
|
+
"null"
|
15555
|
+
]
|
15556
|
+
}
|
15557
|
+
},
|
15558
|
+
"links": [
|
15559
|
+
{
|
15560
|
+
"description": "Retrieve Team Preferences",
|
15561
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
15562
|
+
"method": "GET",
|
15563
|
+
"rel": "self",
|
15564
|
+
"targetSchema": {
|
15565
|
+
"$ref": "#/definitions/team-preferences"
|
15566
|
+
},
|
15567
|
+
"title": "List"
|
15568
|
+
},
|
15569
|
+
{
|
15570
|
+
"description": "Update Team Preferences",
|
15571
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
15572
|
+
"method": "PATCH",
|
15573
|
+
"rel": "update",
|
15574
|
+
"schema": {
|
15575
|
+
"type": [
|
15576
|
+
"object"
|
15577
|
+
],
|
15578
|
+
"properties": {
|
15579
|
+
"addons-controls": {
|
15580
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
15581
|
+
}
|
15582
|
+
}
|
15583
|
+
},
|
15584
|
+
"targetSchema": {
|
15585
|
+
"$ref": "#/definitions/team-preferences"
|
15586
|
+
},
|
15587
|
+
"title": "Update"
|
15588
|
+
}
|
15589
|
+
],
|
15590
|
+
"properties": {
|
15591
|
+
"default-permission": {
|
15592
|
+
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
15593
|
+
},
|
15594
|
+
"addons-controls": {
|
15595
|
+
"$ref": "#/definitions/team-preferences/definitions/addons-controls"
|
15886
15596
|
}
|
15887
15597
|
}
|
15888
15598
|
},
|
15599
|
+
"team-space": {
|
15600
|
+
"description": "A space is an isolated, highly available, secure app execution environment.",
|
15601
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
15602
|
+
"stability": "prototype",
|
15603
|
+
"strictProperties": true,
|
15604
|
+
"title": "Heroku Platform API - Team Space",
|
15605
|
+
"type": [
|
15606
|
+
"object"
|
15607
|
+
],
|
15608
|
+
"links": [
|
15609
|
+
{
|
15610
|
+
"description": "List spaces owned by the team",
|
15611
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/spaces",
|
15612
|
+
"method": "GET",
|
15613
|
+
"rel": "instances",
|
15614
|
+
"targetSchema": {
|
15615
|
+
"items": {
|
15616
|
+
"$ref": "#/definitions/space"
|
15617
|
+
},
|
15618
|
+
"type": [
|
15619
|
+
"array"
|
15620
|
+
]
|
15621
|
+
},
|
15622
|
+
"title": "List"
|
15623
|
+
}
|
15624
|
+
]
|
15625
|
+
},
|
15889
15626
|
"team": {
|
15890
15627
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
15891
15628
|
"description": "Teams allow you to manage access to a shared group of applications and other resources.",
|
@@ -15965,12 +15702,11 @@
|
|
15965
15702
|
"id": {
|
15966
15703
|
"$ref": "#/definitions/identity-provider/definitions/id"
|
15967
15704
|
},
|
15968
|
-
"
|
15969
|
-
"
|
15970
|
-
|
15971
|
-
|
15972
|
-
|
15973
|
-
]
|
15705
|
+
"name": {
|
15706
|
+
"$ref": "#/definitions/identity-provider/definitions/name"
|
15707
|
+
},
|
15708
|
+
"owner": {
|
15709
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
15974
15710
|
}
|
15975
15711
|
}
|
15976
15712
|
},
|
@@ -17489,160 +17225,6 @@
|
|
17489
17225
|
"title": "Update"
|
17490
17226
|
}
|
17491
17227
|
]
|
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
17228
|
}
|
17647
17229
|
},
|
17648
17230
|
"properties": {
|
@@ -17739,14 +17321,14 @@
|
|
17739
17321
|
"dyno": {
|
17740
17322
|
"$ref": "#/definitions/dyno"
|
17741
17323
|
},
|
17324
|
+
"enterprise-account-daily-usage": {
|
17325
|
+
"$ref": "#/definitions/enterprise-account-daily-usage"
|
17326
|
+
},
|
17742
17327
|
"enterprise-account-member": {
|
17743
17328
|
"$ref": "#/definitions/enterprise-account-member"
|
17744
17329
|
},
|
17745
|
-
"enterprise-account-usage
|
17746
|
-
"$ref": "#/definitions/enterprise-account-usage
|
17747
|
-
},
|
17748
|
-
"enterprise-account-usage-monthly": {
|
17749
|
-
"$ref": "#/definitions/enterprise-account-usage-monthly"
|
17330
|
+
"enterprise-account-monthly-usage": {
|
17331
|
+
"$ref": "#/definitions/enterprise-account-monthly-usage"
|
17750
17332
|
},
|
17751
17333
|
"enterprise-account": {
|
17752
17334
|
"$ref": "#/definitions/enterprise-account"
|
@@ -17880,9 +17462,6 @@
|
|
17880
17462
|
"space": {
|
17881
17463
|
"$ref": "#/definitions/space"
|
17882
17464
|
},
|
17883
|
-
"ssl-endpoint": {
|
17884
|
-
"$ref": "#/definitions/ssl-endpoint"
|
17885
|
-
},
|
17886
17465
|
"stack": {
|
17887
17466
|
"$ref": "#/definitions/stack"
|
17888
17467
|
},
|
@@ -17898,6 +17477,9 @@
|
|
17898
17477
|
"team-app": {
|
17899
17478
|
"$ref": "#/definitions/team-app"
|
17900
17479
|
},
|
17480
|
+
"team-daily-usage": {
|
17481
|
+
"$ref": "#/definitions/team-daily-usage"
|
17482
|
+
},
|
17901
17483
|
"team-feature": {
|
17902
17484
|
"$ref": "#/definitions/team-feature"
|
17903
17485
|
},
|
@@ -17910,18 +17492,15 @@
|
|
17910
17492
|
"team-member": {
|
17911
17493
|
"$ref": "#/definitions/team-member"
|
17912
17494
|
},
|
17495
|
+
"team-monthly-usage": {
|
17496
|
+
"$ref": "#/definitions/team-monthly-usage"
|
17497
|
+
},
|
17913
17498
|
"team-preferences": {
|
17914
17499
|
"$ref": "#/definitions/team-preferences"
|
17915
17500
|
},
|
17916
17501
|
"team-space": {
|
17917
17502
|
"$ref": "#/definitions/team-space"
|
17918
17503
|
},
|
17919
|
-
"team-usage-daily": {
|
17920
|
-
"$ref": "#/definitions/team-usage-daily"
|
17921
|
-
},
|
17922
|
-
"team-usage-monthly": {
|
17923
|
-
"$ref": "#/definitions/team-usage-monthly"
|
17924
|
-
},
|
17925
17504
|
"team": {
|
17926
17505
|
"$ref": "#/definitions/team"
|
17927
17506
|
},
|
@@ -17939,9 +17518,6 @@
|
|
17939
17518
|
},
|
17940
17519
|
"vpn-connection": {
|
17941
17520
|
"$ref": "#/definitions/vpn-connection"
|
17942
|
-
},
|
17943
|
-
"whitelisted-add-on-service": {
|
17944
|
-
"$ref": "#/definitions/whitelisted-add-on-service"
|
17945
17521
|
}
|
17946
17522
|
},
|
17947
17523
|
"description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",
|