-
Notifications
You must be signed in to change notification settings - Fork 0
/
cldthrd_api.yaml
1059 lines (1007 loc) · 30.6 KB
/
cldthrd_api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
version: 0.0.2
title: Cloudthread API
description: |
This API allows for interaction with Cloudthread cloud cost management Platform.
termsOfService: https://www.cloudthread.io/terms-of-use
contact:
email: hey@cloudthread.io
servers:
- url: 'https://api.cloudthread.io'
tags:
- name: streams
description: Data ingestion streams
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/custom_data
- name: events
description: Custom events that can be overlayed on top of your Cost Views and Unit Metrics
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/events
- name: tag-catalog
description: Tag catalog manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/tag_catalog
- name: cost-views
description: Cost Views manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/metrics#cost-view-fetch
- name: unit-metrics
description: Unit Metric manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/metrics#unit-metric-fetch
- name: users
description: Users manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/users
- name: teams
description: Teams manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/teams
- name: savings-opportunities
description: Savings Opportunities manipulation
externalDocs:
description: Find out more
url: https://docs.cloudthread.io/v/api-docs/reference/api-reference/savings-hub/opportunities-explorer
paths:
/streams/ingest:
post:
summary: Ingests data into created Data Stream
operationId: ingest_stream_data
tags:
- streams
requestBody:
$ref: '#/components/requestBodies/StreamData'
security:
- ApiKeyAuth: []
responses:
201:
description: Ingested successfully
400:
description: Validation error
404:
description: No stream found
/events:
post:
summary: Ingests the custom events data
description: Ingests the custom events data that can be overlayed on top of your Cost Views and Unit Metrics
operationId: create_events
tags:
- events
requestBody:
$ref: '#/components/requestBodies/CreateEvents'
security:
- ApiKeyAuth: [ ]
responses:
201:
description: Ingested successfully
400:
description: Validation error
404:
description: No team found
/tag-catalog:
get:
summary: Fetches a Tag Catalog entry via catalog key
operationId: get_tag_catalog
tags:
- tag-catalog
parameters:
- $ref: '#/components/parameters/CatalogKey'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Tag catalog data
content:
application/json:
schema:
$ref: '#/components/schemas/GetTagCatalogPayload'
/cost/metric/{metric_id}:
get:
summary: Returns cost data from Cloudthread Cost View
operationId: get_cost_metric_filter_data
tags:
- cost-views
parameters:
- $ref: '#/components/parameters/MetricID'
- $ref: '#/components/parameters/StartDate'
- $ref: '#/components/parameters/EndDate'
- $ref: '#/components/parameters/CostType'
- $ref: '#/components/parameters/Amortization'
- $ref: '#/components/parameters/Exclude'
- $ref: '#/components/parameters/Granularity'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Metric data
content:
application/json:
schema:
$ref: '#/components/schemas/GetCostViewPayload'
/unit/metric/{metric_id}:
get:
summary: Returns cost data from Cloudthread Unit Metric
operationId: get_unit_metric_filter_data
tags:
- unit-metrics
parameters:
- $ref: '#/components/parameters/MetricID'
- $ref: '#/components/parameters/StartDate'
- $ref: '#/components/parameters/EndDate'
- $ref: '#/components/parameters/CostType'
- $ref: '#/components/parameters/Amortization'
- $ref: '#/components/parameters/Exclude'
- $ref: '#/components/parameters/Granularity'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Metric data
content:
application/json:
schema:
$ref: '#/components/schemas/GetUnitMetricPayload'
/users:
get:
summary: Returns data on users
description: Returns data on registered Users of Cloudthread platform
operationId: get_users
tags:
- users
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of users
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersResponse'
/teams:
get:
summary: Returns list of Teams
description: Fetches list of Teams within the org
operationId: get_teams_within_org
tags:
- teams
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of teams
content:
application/json:
schema:
$ref: '#/components/schemas/GetTeamsResponse'
post:
summary: Creates new Team
description: Creates new Team within the org
operationId: create_team
tags:
- teams
requestBody:
$ref: '#/components/requestBodies/CreateTeam'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Team created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TeamResponse'
400:
description: Validation error
404:
description: Slack integration or Slack channel not found
/teams/{team_id}:
get:
summary: Returns specific Team
description: Fetches data on a specific Team within the org
operationId: get_team_within_org
tags:
- teams
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Get team
content:
application/json:
schema:
$ref: '#/components/schemas/TeamResponse'
patch:
summary: Updates existing Team
operationId: update_team
tags:
- teams
requestBody:
$ref: '#/components/requestBodies/CreateTeam'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: Updated
content:
application/json:
schema:
$ref: '#/components/schemas/TeamResponse'
400:
description: Validation error
404:
description: Slack integration/slack channel not found/team not found
delete:
summary: Deletes existing Team
operationId: delete_team
tags:
- teams
security:
- ApiKeyAuth: [ ]
responses:
204:
description: Deleted
404:
description: Team not found
/teams/{team_id}/members:
get:
operationId: get_team_members
summary: Returns list of Team members
description: Fetches list of members of specific Team
tags:
- teams
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of team members
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersResponse'
/teams/{team_id}/members/assign:
post:
operationId: assign_users_to_team
summary: Adds new Users to specific Team
tags:
- teams
requestBody:
$ref: '#/components/requestBodies/AssignUsersToTeam'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of team members
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersResponse'
/teams/{team_id}/members/delete:
post:
operationId: assign_users_to_team
summary: Deletes Users from specific Team
tags:
- teams
requestBody:
$ref: '#/components/requestBodies/RemoveUsersFromTeam'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of team members
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersResponse'
/cost-optimization/opportunities/list:
post:
operationId: get_opportunities
summary: Returns the list of Savings Opportunities
tags:
- savings-opportunities
requestBody:
$ref: '#/components/requestBodies/GetOpportunitiesQuery'
security:
- ApiKeyAuth: [ ]
responses:
200:
description: List of savings opportunities
content:
application/json:
schema:
$ref: '#/components/schemas/GetOpportunitiesResponse'
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
parameters:
CatalogKey:
name: catalog_key
in: query
description: Tag Catalog key
required: true
schema:
type: string
MetricID:
name: metric_id
in: path
description: Cost View or Unit Metric ID
required: true
schema:
type: string
TeamID:
name: team_id
in: path
description: team id
required: true
schema:
type: string
StartDate:
name: start_date
in: query
description: Start Date
required: true
schema:
type: string
EndDate:
name: end_date
in: query
description: End Date
required: true
schema:
type: string
CostType:
name: cost_type
in: query
description: Cost Type or Cost Column ID
required: false
schema:
oneOf:
- type: string
- type: integer
Amortization:
name: amortization
in: query
description: Cost Data Amortization
required: false
schema:
type: boolean
Exclude:
name: exclude
in: query
description: Excluded Payment Types
required: false
schema:
type: string
Granularity:
name: granularity
in: query
description: Metric Date Granularity
required: false
schema:
type: string
requestBodies:
StreamData:
description: Definition of the data stream
content:
application/json:
schema:
$ref: '#/components/schemas/StreamData'
CreateEvents:
description: Create events for Events Overlay
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEvents'
CreateTeam:
description: Create team
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTeamRequest'
AssignUsersToTeam:
description: Assign Users to Team
content:
application/json:
schema:
description: List of Users
properties:
users_ids:
type: array
description: List of User IDs
items:
type: string
description: User ID
RemoveUsersFromTeam:
description: Remove users from Team
content:
application/json:
schema:
description: List of Users
properties:
users_ids:
type: array
description: List of User IDs
items:
type: string
description: User ID
GetOpportunitiesQuery:
description: Query to filter opportunities
content:
application/json:
schema:
$ref: '#/components/schemas/GetOpportunitiesQuery'
schemas:
StreamData:
description: Stream data
type: object
required:
- data_stream_token
- metric_agg_func
- data
properties:
data_stream_token:
type: string
example: sometoken
description: Data stream token
metric_agg_func:
type: string
example: Sum | Average | Minimum | Maximum
description: Aggregation function identifier (Sum | Average | Minimum | Maximum)
data:
type: array
description: Data timeseries
items:
$ref: '#/components/schemas/StreamDataPayload'
StreamDataPayload:
description: Payload for data ingestion stream
type: object
required:
- timestamp
- metric_name
- metric_value
properties:
timestamp:
type: string
format: date-time
example: yyyyMMddHHmmss
description: Can be either timestamp or datetime string
metric_name:
type: string
example: customers
description: The name of the metric being ingested
metric_value:
type: number
format: float
example: 3.14
description: The value of the metric being ingested
custom_dimensions:
type: object
description: Map of up to 10 key value pairs that you will be able to segment the data by on the Cloudthread platform
example: [[region1, 20.5], [region2, 7.0]]
CreateEvents:
description: List of Events with their properties
type: object
properties:
data:
type: array
description: Event data
items:
$ref: '#/components/schemas/CreateEventsData'
CreateEventsData:
description: Properties defining the Event
type: object
required:
- timestamp
- payload
properties:
timestamp:
type: string
format: date-time
example: yyyyMMddHHmmss
description: Can be either timestamp or datetime string
team_id:
type: integer
example: 1
description: ID of the team that events are relevant to (if teams are defined)
payload:
$ref: '#/components/schemas/EventsPayload'
EventsPayload:
description: Events data payload
type: object
required:
- type
properties:
type:
type: string
example: deploy
description: Event type (deploy, outage, etc.)
description:
type: string
example: Major code improvements
description: Event description
event_url:
type: string
example: https://foo.org
description: Link to event details if applicable
GetTagCatalogPayload:
description: Tag Catalog fetch response
type: object
properties:
tags:
type: array
description: List of tags
items:
$ref: '#/components/schemas/Tags'
GetCostViewPayload:
description: Data returned by query of Cost View
type: object
properties:
data:
type: array
description: List of Cost View data points (timeseries)
items:
$ref: '#/components/schemas/GetCostViewDataPoint'
GetCostViewDataPoint:
description: Data point for Cost View for specific date
type: object
properties:
current_timeframe_cost:
type: number
format: float
description: Cost ($) for current period
previous_timeframe_cost:
type: number
format: float
description: Cost ($) for previous period
pop_diff:
type: number
format: float
description: Period-over-period difference total ($)
pop_change:
type: number
format: float
description: Period-over-period change (% decimal)
date:
type: string
example: YYYYMMDD
description: Period date
GetUnitMetricPayload:
description: Data returned by query of Unit Metric
type: object
properties:
data:
type: array
description: List of Unit Metric data points (timeseries)
items:
$ref: '#/components/schemas/GetUnitMetricDataPoint'
GetUnitMetricDataPoint:
description: Data point for Unit Metric for specific date
type: object
properties:
current_timeframe_denominator:
type: number
format: float
description: Denominator value for current period
current_timeframe_numerator:
type: number
format: float
description: Numerator value for current period ($)
current_timeframe_unit_metric:
type: number
format: float
description: Calculated unit metric for current period ($)
previous_timeframe_denominator:
type: number
format: float
description: Denominator value for previous period
previous_timeframe_numerator:
type: number
format: float
description: Numerator value for previous period ($)
previous_timeframe_unit_metric:
type: number
format: float
description: Calculated unit metric for previous period ($)
pop_diff:
type: number
format: float
description: Period-over-period difference total ($)
pop_change:
type: number
format: float
description: Period-over-period change (% decimal)
d_agg_func:
type: string
description: Denominator aggregation function (SUM, AVERAGE, etc.)
n_agg_func:
type: string
description: Denominator aggregation function (SUM, AVERAGE, etc.)
date:
type: string
description: Period date
User:
description: Registered User on Cloudthread platform
type: object
required:
- id
- email
- name
properties:
id:
type: string
description: User type (Admin, User)
email:
type: string
description: User email
name:
type: string
description: User name
GetUsersResponse:
description: List of Users
type: array
items:
$ref: '#/components/schemas/User'
CreateTeamRequest:
description: Request to create a Team definition
type: object
required:
- id
- name
properties:
id:
type: string
description: Team ID
name:
type: string
description: Team name
slack_channel:
type: string
description: Slack channel link for the team notifications
aws_account_ids:
type: array
description: Team-level data filter – AWS accounts list
items:
type: string
description: AWS account ID
aws_bill_payer_account_ids:
type: array
description: Team-level data filter – AWS Payer accounts list
items:
type: string
description: AWS account ID
aws_region_names:
type: array
description: Team-level data filter – AWS regions list
items:
type: string
description: AWS region name (e.g. us-east-1)
aws_services:
type: array
description: Team-level data filter – AWS services list
items:
type: string
description: AWS service name (e.g. Amazon S3)
aws_tags:
type: array
description: Team-level data filter – AWS resource tags list
items:
type: object
description: AWS resource tag (key-value pair)
aws_account_tags:
type: array
description: Team-level data filter – AWS account tags list
items:
type: object
description: AWS account tag (key-value pair)
gcp_project_names:
type: array
description: Team-level data filter – GCP projects list
items:
type: string
description: GCP project ID
gcp_billing_account_ids:
type: array
description: Team-level data filter – GCP billing accounts ID list
items:
type: string
description: GCP billing account ID
gcp_sku_ids:
type: array
description: Team-level data filter – GCP SKU ID list
items:
type: string
description: GCP SKU ID
gcp_locations:
type: array
description: Team-level data filter – GCP locations list
items:
type: string
description: GCP location name
gcp_services:
type: array
description: Team-level data filter – GCP services list
items:
type: string
description: GCP service name
gcp_labels:
type: array
description: Team-level data filter – GCP labels list
items:
type: object
description: GCP label (key-value pair)
custom_stream_tokens:
type: array
description: Custom stream tokens list
items:
type: string
description: Custom stream token
custom_metric_names:
type: array
description: Custom stream metrics list
items:
type: string
description: Custom stream metric
custom_dimensions:
type: array
description: Custom dimensions list
items:
type: object
description: Custom dimension
opportunity_priorities:
type: array
description: Opportunity priority definition list
items:
type: integer
description: Opportunity priority identifier
TeamResponse:
description: Properties defining the Team
type: object
properties:
id:
type: string
description: Team ID
name:
type: string
description: Team name
slack_channel:
type: string
description: Slack channel link for the team notifications
aws_account_ids:
type: array
description: Team-level data filter – AWS accounts list
items:
type: string
description: AWS account ID
aws_bill_payer_account_ids:
type: array
description: Team-level data filter – AWS Payer accounts list
items:
type: string
description: AWS account ID
aws_region_names:
type: array
description: Team-level data filter – AWS regions list
items:
type: string
description: AWS region name (e.g. us-east-1)
aws_services:
type: array
description: Team-level data filter – AWS services list
items:
type: string
description: AWS service name (e.g. Amazon S3)
aws_tags:
type: array
description: Team-level data filter – AWS resource tags list
items:
type: object
description: AWS resource tag (key-value pair)
aws_account_tags:
type: array
description: Team-level data filter – AWS account tags list
items:
type: object
description: AWS account tag (key-value pair)
gcp_project_names:
type: array
description: Team-level data filter – GCP projects list
items:
type: string
description: GCP project ID
gcp_billing_account_ids:
type: array
description: Team-level data filter – GCP billing accounts ID list
items:
type: string
description: GCP billing account ID
gcp_sku_ids:
type: array
description: Team-level data filter – GCP SKU ID list
items:
type: string
description: GCP SKU ID
gcp_locations:
type: array
description: Team-level data filter – GCP locations list
items:
type: string
description: GCP location name
gcp_services:
type: array
description: Team-level data filter – GCP services list
items:
type: string
description: GCP service name
gcp_labels:
type: array
description: Team-level data filter – GCP labels list
items:
type: object
description: GCP label (key-value pair)
custom_stream_tokens:
type: array
description: Custom stream tokens list
items:
type: string
description: Custom stream token
custom_metric_names:
type: array
description: Custom stream metrics list
items:
type: string
description: Custom stream metric
custom_dimensions:
type: array
description: Custom dimensions list
items:
type: object
description: Custom dimension
opportunity_priorities:
type: array
description: Opportunity priority definition list
items:
type: integer
description: Opportunity priority identifier
GetTeamsResponse:
description: List of Teams with their properties
type: array
items:
$ref: '#/components/schemas/TeamResponse'
GetOpportunitiesQuery:
description: Filter parameters to retrieve the list of matching opportunities
type: object
properties:
opportunity_type_id:
type: string
description: Opportunity type ID
status:
type: string
description: Opportunity status (e.g. Assigned, In Progress, Validation, Done, etc.)
code_automation:
type: boolean
description: Opportunity automation option (True/False)
thread_id:
type: integer
description: ID of Thread that contains opportunity (if assigned)
account:
type: string
description: ID of cloud account related to resource featured in opportunity
region:
type: string
description: Name of region related to resource featured in opportunity
service:
type: string
description: Name of service related to resource featured in opportunity
tags:
type: array
description: Tags of resource featured in opportunity
items:
$ref: '#/components/schemas/Tags'
category:
type: string
description: Opportunity category (e.g. Redshift Righsizing)
record_id:
type: string
description: ID of resource featured in opportunity
source:
type: string
description: Opportunity data source (e.g. Cloudthread, AWS Compute Optimizer, etc.)
github_pr_key:
type: string
description: GitHub Pull Request related to opportunity
secondary_id:
type: integer
description: Secondary ID of opportunity
last_detected_start_date:
type: string
format: date
description: Date filter for last detected date (start value)
last_detected_end_date:
type: string
format: date
description: Date filter for last detected date (end value)
status_updated_start_date:
type: string
format: date
description: Date filter for status updated date (start value)
status_updated_end_date:
type: string
format: date
description: Date filter for status updated date (end value)
details:
type: boolean
description: If opportunity details present (True/False)
priority:
type: integer
description: Opportunity priority (1, 2, 3, etc.)
Tags:
description: Cost allocation resource tags
type: object
properties:
Key: