-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1394 lines (1384 loc) · 46.9 KB
/
openapi.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.1.0"
info:
title: "Nango API"
description: "Nango API specs used to authorize & sync data with external APIs."
version: "1.0.0"
servers:
- url: https://api.nango.dev
description: Production server
x-speakeasy-server-id: prod
- url: http://localhost:3003
description: Local server
x-speakeasy-server-id: local
security:
- api_key: []
paths:
/config:
get:
tags:
- integrations
description: Returns a list of integrations
summary: Returns a list of integrations including their unique keys and providers as configured in the Nango API.
operationId: listIntegrations
x-speakeasy-name-override: list
responses:
"200":
description: Successfully returned a list of integrations
content:
application/json:
schema:
$ref: "#/components/schemas/IntegrationsResponse200"
post:
tags:
- integrations
description: Create a new integration
summary: Create a new integration including its provider configuration, OAuth details if applicable, and associated integration ID.
operationId: createIntegrations
x-speakeasy-name-override: create
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListIntegrationsRequest"
responses:
"200":
description: Successfully created an integration
content:
application/json:
schema:
$ref: "#/components/schemas/IntegrationsResponse200"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
put:
tags:
- integrations
description: Edit an integration (only for OAuth APIs)
summary: Edit an integration, specifically tailored for OAuth APIs, updating the provider configuration along with OAuth client ID and secret.
operationId: updateIntegration
x-speakeasy-name-override: update
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateIntegrationRequest"
responses:
"200":
description: Successfully edit an integration
content:
application/json:
schema:
$ref: "#/components/schemas/IntegrationsResponse200"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
"404":
description: Unknown integration
content:
application/json:
schema:
$ref: "#/components/schemas/Response404"
/config/{providerConfigKey}:
get:
tags:
- integrations
description: Returns a specific integration
summary: Returns details of a specific integration identified by its provider configuration key, optionally including credentials if specified.
operationId: getIntegration
x-speakeasy-name-override: fetch
parameters:
- name: providerConfigKey
in: path
required: true
schema:
type: string
description: The integration ID that you created in Nango.
- name: include_creds
in: query
required: false
description: If true, the response will contain the client ID, secret, scopes, auth_mode and app link - if applicable. include_creds is false by default.
schema:
type: boolean
responses:
"200":
description: Successfully returned an integration
content:
application/json:
schema:
$ref: "#/components/schemas/GetIntegrationResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
"404":
description: Unknown integration
content:
application/json:
schema:
$ref: "#/components/schemas/Response404"
delete:
tags:
- integrations
description: Deletes a specific integration
summary: Deletes a specific integration identified by its provider configuration key.
operationId: deleteIntegration
x-speakeasy-name-override: delete
parameters:
- name: providerConfigKey
in: path
required: true
schema:
type: string
description: The integration ID that you created in Nango.
responses:
"204":
description: Successfully deleled an integration
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
"404":
description: Unknown integration
content:
application/json:
schema:
$ref: "#/components/schemas/Response404"
/connection:
get:
tags:
- connections
description: Returns a list of connections
summary: Returns a list of connections, optionally filtered by connection ID.
operationId: listConnections
x-speakeasy-name-override: list
parameters:
- name: connectionId
in: query
schema:
type: string
description: Filter the list of connections based on this connection ID.
responses:
"200":
description: Successfully returned a list of connections
content:
application/json:
schema:
$ref: "#/components/schemas/GetConnectionResponse"
post:
tags:
- connections
description: Adds a connection for which you already have an access token
summary: Adds a connection using an existing access token, along with optional OAuth or basic authentication credentials, and additional metadata or configuration.
operationId: createConnection
x-speakeasy-name-override: create
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateConnectionRequest"
responses:
"200":
description: Successfully created an integrations
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/connection/{connectionId}:
get:
tags:
- connections
description: Returns a specific connection
summary: Returns details of a specific connection identified by its connection ID, associated with the specified integration, with optional parameters for force refresh and returning the refresh token.
operationId: getConnections
x-speakeasy-name-override: get
parameters:
- name: connectionId
in: path
required: true
schema:
type: string
description: The connection ID used to create the connection.
- name: provider_config_key
in: query
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
- name: force_refresh
in: query
description: If true, Nango will attempt to refresh the access access token regardless of its expiration status (false by default).
schema:
type: boolean
- name: refresh_token
in: query
description: If true, return the refresh token as part of the response (false by default).
schema:
type: boolean
responses:
"200":
description: Successfully returned a connection
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
"404":
description: Unknown Connection
content:
application/json:
schema:
$ref: "#/components/schemas/Response404"
delete:
tags:
- connections
description: Deletes a specific connection
summary: Deletes a specific connection identified by its connection ID, associated with the specified integration.
operationId: deleteConnections
x-speakeasy-name-override: delete
parameters:
- name: connectionId
in: path
required: true
schema:
type: string
description: The connection ID used to create the connection.
- name: provider_config_key
in: query
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
responses:
"204":
description: Successfully deleled an connection
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
"404":
description: Unknown connection
content:
application/json:
schema:
$ref: "#/components/schemas/Response404"
/connection/{connectionId}/metadata:
post:
tags:
- connections
description: Set custom metadata for the connection.
summary: Set custom metadata for the specified connection.
operationId: createMetadata
x-speakeasy-name-override: createMetadata
parameters:
- name: connectionId
in: path
required: true
schema:
type: string
description: The connection ID used to create the connection.
- name: Provider-Config-Key
in: header
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
"201":
description: Successfully created an integrations
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
patch:
tags:
- connections
description: Update custom metadata for the connection.
summary: Update custom metadata for the specified connection.
operationId: updateMetadata
x-speakeasy-name-override: update
parameters:
- name: connectionId
in: path
required: true
schema:
type: string
description: The connection ID used to create the connection.
- name: Provider-Config-Key
in: header
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
"200":
description: Successfully updated the metadata
content:
application/json:
schema:
type: object
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/records:
get:
tags:
- records
description: Returns data synced with Nango Sync
summary: Returns data synced with Nango Sync, filtered by specified parameters.
operationId: getRecord
x-speakeasy-name-override: get
parameters:
- name: model
in: query
required: true
schema:
type: string
description: The data model to fetch
- name: delta
in: query
required: false
schema:
type: string
description: Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed only records added or updated after this timestamp are returned, otherwise all records are returned.
- name: limit
in: query
required: false
schema:
type: integer
description: The maximum number of records to return. If not passed, all records are returned.
- name: cursor
in: query
required: false
schema:
type: string
description: |
Base 64 encoded value that can be used to fetch the next page of results. The cursor will be included until there are no more results to paginate through.
- name: filter
in: query
required: false
schema:
type: string
enum: [added, updated, deleted]
description: Filter to only show results that have been added or updated or deleted. Helpful when used in conjuction with the delta parameter to retrieve a subset or records that were added, updated, or deleted with the latest sync.
- name: Connection-Id
in: header
required: true
description: The connection ID used to create the connection.
schema:
type: string
- name: Provider-Config-Key
in: header
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
responses:
"200":
description: Successfully returned records
content:
application/json:
schema:
$ref: "#/components/schemas/GetRecordResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/records:
get:
tags:
- sync
description: Returns data synced with Nango Sync
summary: Returns data synced with Nango Sync, allowing for advanced filtering, sorting, and pagination options.
operationId: getSyncRecord
x-speakeasy-name-override: getRecord
parameters:
- name: model
in: query
required: true
schema:
type: string
description: The data model to fetch
- name: delta
in: query
required: false
schema:
type: string
description: Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed only records added or updated after this timestamp are returned, otherwise all records are returned.
- name: limit
in: query
required: false
schema:
type: integer
description: The maximum number of records to return. If not passed, all records are returned.
- name: offset
in: query
required: false
schema:
type: integer
description: The number of records to skip. If not passed, no records are skipped.
- name: sort_by
in: query
required: false
schema:
type: string
enum: [created_at, updated_at, id]
description: Set how the records are sorted. The default is id. The options are 'created_at', 'updated_at', 'id'.
- name: order
in: query
required: false
schema:
type: string
enum: [desc, asc]
description: Set the order of results. The default is 'desc'. The options are 'desc' or 'asc'.
- name: filter
in: query
required: false
schema:
type: string
enum: [added, updated, deleted]
description: Filter to only show results that have been added or updated or deleted. Helpful when used in conjuction with the delta parameter to retrieve a subset or records that were added, updated, or deleted with the latest sync.
- name: Connection-Id
in: header
required: true
description: The connection ID used to create the connection.
schema:
type: string
- name: Provider-Config-Key
in: header
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
responses:
"200":
description: Successfully returned records
content:
application/json:
schema:
$ref: "#/components/schemas/GetSyncRecordResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/trigger:
post:
tags:
- sync
description: Triggers an additional, one-off execution of specified sync(s) (for a given connection or all applicable connections if no connection is specified).
summary: Triggers an additional, one-off execution of specified sync(s) for a given connection or all applicable connections if no connection is specified.
operationId: createSyncTrigger
x-speakeasy-name-override: createTrigger
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSyncTriggerRequest"
responses:
"200":
description: Successfully triggered the sync
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/start:
post:
tags:
- sync
description: Starts the continuous execution of specified sync(s) (for a given connection or all applicable connections if no connection is specified).
summary: Starts the continuous execution of specified sync(s) for a given connection or all applicable connections if no connection is specified.
operationId: createSyncStart
x-speakeasy-name-override: createSyncStart
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSyncStartRequest"
responses:
"200":
description: Successfully started the sync
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/pause:
post:
tags:
- sync
description: Pauses the continuous execution of specified sync(s) (for a given connection or all applicable connections if no connection is specified).
summary: Pauses the continuous execution of specified sync(s) for a given connection or all applicable connections if no connection is specified.
operationId: createSyncPause
x-speakeasy-name-override: pause
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSyncPauseRequest"
responses:
"200":
description: Successfully paused the sync
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/status:
get:
tags:
- sync
description: Get the status of specified sync(s) (for a given connection or all applicable connections if no connection is specified)
summary: Get the status of specified sync(s) for a given connection or all applicable connections if no connection is specified.
operationId: getSyncStatus
x-speakeasy-name-override: status
parameters:
- name: provider_config_key
in: query
required: true
schema:
type: string
description: The ID of the integration you established within Nango
- name: syncs
in: query
required: true
schema:
type: string
description: The name of the syncs you want to fetch a status for. Pass in "*" to return all syncs per the integration
- name: connection_id
in: query
required: false
schema:
type: string
description: The ID of the connection. If omitted, all connections will be surfaced.
responses:
"200":
description: Successfully returned a list of syncs and their status
content:
application/json:
schema:
$ref: "#/components/schemas/GetSyncStatusResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/sync/update-connection-frequency:
put:
tags:
- sync
description: Override a sync's default frequency for a specific connection, or revert to the default frequency.
summary: Override a sync's default frequency for a specific connection or revert to the default frequency.
operationId: updateConnectionFrequency
x-speakeasy-name-override: updateConnectionFrequency
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateConnectionFrequencyRequest"
responses:
"200":
description: Successfully updated the frequency
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateConnectionFrequencyResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/action/trigger:
post:
tags:
- action
description: Triggers an action for a connection
summary: Triggers an action for a connection.
operationId: createActionTrigger
x-speakeasy-name-override: createTrigger
parameters:
- name: Connection-Id
in: header
required: true
description: The connection ID used to create the connection.
schema:
type: string
- name: Provider-Config-Key
in: header
required: true
description: The integration ID used to create the connection (aka Unique Key).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateActionTriggerRequest"
responses:
"200":
description: Returns the result of the action
content:
application/json:
schema:
$ref: "#/components/schemas/CreateActionTriggerResponse"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Response400"
/environment-variables:
get:
description: Retrieve the environment variables as added in the Nango dashboard
summary: Retrieve the environment variables as added in the Nango dashboard.
operationId: getEnvironmentVariable
x-speakeasy-name-override: getEnvironmentVariables
responses:
"200":
description: Retrieve the environment variables as added in the Nango dashboard
content:
application/json:
schema:
$ref: "#/components/schemas/GetEnvironmentVariableResponse"
/proxy/{anyPath}:
get:
tags:
- proxy
description: Make a GET request with the Proxy.
summary: Make a GET request with the Proxy.
operationId: getProxy
x-speakeasy-name-override: get
parameters:
- name: anyPath
in: path
required: true
schema:
type: string
- name: $ANY_QUERY_PARAMS
in: query
required: true
schema:
type: string
- in: header
name: Connection-Id
required: true
schema:
type: string
description: The connection ID used to create the connection.
- in: header
name: Provider-Config-Key
required: true
schema:
type: string
description: The integration ID used to create the connection (aka Unique Key).
- in: header
name: Retries
schema:
type: string
description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
- in: header
name: Base-Url-Override
schema:
type: string
description: Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional
- in: header
name: Decompress
schema:
type: string
description: Override the decompress option when making requests. Optional, defaults to false
- in: header
name: nango-proxy-$ANY_HEADER
schema:
type: string
description: Any other headers you send are passed on to the external API
responses:
"200":
description: The response exactly as returned by the external API
post:
tags:
- proxy
description: Make a POST request with the Proxy.
summary: Make a POST request with the Proxy.
operationId: createProxy
x-speakeasy-name-override: create
parameters:
- name: anyPath
in: path
required: true
schema:
type: string
- in: header
name: Connection-Id
required: true
schema:
type: string
description: The connection ID used to create the connection.
- in: header
name: Provider-Config-Key
required: true
schema:
type: string
description: The integration ID used to create the connection (aka Unique Key).
- in: header
name: Retries
schema:
type: string
description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
- in: header
name: Base-Url-Override
schema:
type: string
description: Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional
- in: header
name: Decompress
schema:
type: string
description: Override the decompress option when making requests. Optional, defaults to false
- in: header
name: nango-proxy-$ANY_HEADER
schema:
type: string
description: Any other headers you send are passed on to the external API
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProxyRequest"
responses:
"200":
description: The response exactly as returned by the external API
put:
tags:
- proxy
description: Make a PUT request with the Proxy.
summary: Make a PUT request with the Proxy.
operationId: putProxy
x-speakeasy-name-override: update
parameters:
- name: anyPath
in: path
required: true
schema:
type: string
- in: header
name: Connection-Id
required: true
schema:
type: string
description: The connection ID used to create the connection.
- in: header
name: Provider-Config-Key
required: true
schema:
type: string
description: The integration ID used to create the connection (aka Unique Key).
- in: header
name: Retries
schema:
type: string
description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
- in: header
name: Base-Url-Override
schema:
type: string
description: Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional
- in: header
name: Decompress
schema:
type: string
description: Override the decompress option when making requests. Optional, defaults to false
- in: header
name: nango-proxy-$ANY_HEADER
schema:
type: string
description: Any other headers you send are passed on to the external API
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PutProxyRequest"
responses:
"200":
description: The response exactly as returned by the external API
patch:
tags:
- proxy
description: Make a PATCH request with the Proxy.
summary: Make a PATCH request with the Proxy.
operationId: patchProxy
x-speakeasy-name-override: patch
parameters:
- name: anyPath
in: path
required: true
schema:
type: string
- in: header
name: Connection-Id
required: true
schema:
type: string
description: The connection ID used to create the connection.
- in: header
name: Provider-Config-Key
required: true
schema:
type: string
description: The integration ID used to create the connection (aka Unique Key).
- in: header
name: Retries
schema:
type: string
description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
- in: header
name: Base-Url-Override
schema:
type: string
description: Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional
- in: header
name: Decompress
schema:
type: string
description: Override the decompress option when making requests. Optional, defaults to false
- in: header
name: nango-proxy-$ANY_HEADER
schema:
type: string
description: Any other headers you send are passed on to the external API
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PatchProxyRequest"
responses:
"200":
description: The response exactly as returned by the external API
delete:
tags:
- proxy
description: Make a DELETE request with the Proxy.
summary: Make a DELETE request with the Proxy.
operationId: deleteProxy
x-speakeasy-name-override: deletes
parameters:
- name: anyPath
in: path
required: true
schema:
type: string
- name: $ANY_QUERY_PARAMS
in: query
required: true
schema:
type: string
- in: header
name: Connection-Id
required: true
schema:
type: string
description: The connection ID used to create the connection.
- in: header
name: Provider-Config-Key
required: true
schema:
type: string
description: The integration ID used to create the connection (aka Unique Key).
- in: header
name: Retries
schema:
type: string
description: The number of retries in case of failure (with exponential back-off). Optional, default 0.
- in: header
name: Base-Url-Override
schema:
type: string
description: Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional
- in: header
name: Decompress
schema:
type: string
description: Override the decompress option when making requests. Optional, defaults to false
- in: header
name: nango-proxy-$ANY_HEADER
schema:
type: string
description: Any other headers you send are passed on to the external API
responses:
"200":
description: The response exactly as returned by the external API
components:
securitySchemes:
api_key:
type: apiKey
name: api_key
in: header
schemas:
GetRecordResponse:
type: object
properties:
records:
type: array
items:
type: object
properties:
your-properties:
type: string
description: The data Nango synced in for you
example: "Your synced data, in the schema you (or Nango) defined in nango.yaml"
_nango_metadata:
type: object
properties:
deleted_at:
type: string
null: true
description: The timestamp at which Nango detected the record as deleted
last_action:
type: string
description: The last action seen on this record
enum: ["ADDED", "UPDATED", "DELETED"]
first_seen_at:
type: string
description: The timestamp at which Nango first saw this record
example: "2023-09-18T15:20:35.941305+00:00"
last_modified_at:
type: string
description: The timestamp at which Nango last detected a change to this record