@opusdns/api 1.208.0 → 1.210.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.
- package/package.json +1 -1
- package/src/helpers/keys.ts +0 -78
- package/src/helpers/schemas.d.ts +0 -4
- package/src/openapi.yaml +602 -337
- package/src/schema.d.ts +167 -85
package/src/openapi.yaml
CHANGED
|
@@ -671,11 +671,6 @@ components:
|
|
|
671
671
|
anyOf:
|
|
672
672
|
- $ref: '#/components/schemas/BrandingDesignDiff'
|
|
673
673
|
- type: 'null'
|
|
674
|
-
notices:
|
|
675
|
-
items:
|
|
676
|
-
$ref: '#/components/schemas/BrandingDesignNotice'
|
|
677
|
-
title: Notices
|
|
678
|
-
type: array
|
|
679
674
|
results:
|
|
680
675
|
items:
|
|
681
676
|
$ref: '#/components/schemas/BrandingDesignVariant'
|
|
@@ -685,92 +680,10 @@ components:
|
|
|
685
680
|
anyOf:
|
|
686
681
|
- $ref: '#/components/schemas/BrandingDesignSource'
|
|
687
682
|
- type: 'null'
|
|
688
|
-
summary:
|
|
689
|
-
default: ''
|
|
690
|
-
title: Summary
|
|
691
|
-
type: string
|
|
692
|
-
summary_parts:
|
|
693
|
-
items:
|
|
694
|
-
$ref: '#/components/schemas/BrandingDesignPhrase'
|
|
695
|
-
title: Summary Parts
|
|
696
|
-
type: array
|
|
697
|
-
warnings:
|
|
698
|
-
items:
|
|
699
|
-
type: string
|
|
700
|
-
title: Warnings
|
|
701
|
-
type: array
|
|
702
683
|
required:
|
|
703
684
|
- results
|
|
704
685
|
title: BrandingDesignContextPayload
|
|
705
686
|
type: object
|
|
706
|
-
BrandingDesignContrast:
|
|
707
|
-
properties:
|
|
708
|
-
all_pass:
|
|
709
|
-
anyOf:
|
|
710
|
-
- type: boolean
|
|
711
|
-
- type: 'null'
|
|
712
|
-
title: All Pass
|
|
713
|
-
checks:
|
|
714
|
-
items:
|
|
715
|
-
$ref: '#/components/schemas/BrandingDesignContrastCheck'
|
|
716
|
-
title: Checks
|
|
717
|
-
type: array
|
|
718
|
-
min_ratio:
|
|
719
|
-
anyOf:
|
|
720
|
-
- type: number
|
|
721
|
-
- type: 'null'
|
|
722
|
-
title: Min Ratio
|
|
723
|
-
title: BrandingDesignContrast
|
|
724
|
-
type: object
|
|
725
|
-
BrandingDesignContrastCheck:
|
|
726
|
-
properties:
|
|
727
|
-
bg:
|
|
728
|
-
anyOf:
|
|
729
|
-
- type: string
|
|
730
|
-
- type: 'null'
|
|
731
|
-
title: Bg
|
|
732
|
-
fg:
|
|
733
|
-
anyOf:
|
|
734
|
-
- type: string
|
|
735
|
-
- type: 'null'
|
|
736
|
-
title: Fg
|
|
737
|
-
hard:
|
|
738
|
-
anyOf:
|
|
739
|
-
- type: boolean
|
|
740
|
-
- type: 'null'
|
|
741
|
-
title: Hard
|
|
742
|
-
kind:
|
|
743
|
-
anyOf:
|
|
744
|
-
- type: string
|
|
745
|
-
- type: 'null'
|
|
746
|
-
title: Kind
|
|
747
|
-
max:
|
|
748
|
-
anyOf:
|
|
749
|
-
- type: number
|
|
750
|
-
- type: 'null'
|
|
751
|
-
title: Max
|
|
752
|
-
min:
|
|
753
|
-
anyOf:
|
|
754
|
-
- type: number
|
|
755
|
-
- type: 'null'
|
|
756
|
-
title: Min
|
|
757
|
-
mode:
|
|
758
|
-
anyOf:
|
|
759
|
-
- type: string
|
|
760
|
-
- type: 'null'
|
|
761
|
-
title: Mode
|
|
762
|
-
ok:
|
|
763
|
-
anyOf:
|
|
764
|
-
- type: boolean
|
|
765
|
-
- type: 'null'
|
|
766
|
-
title: Ok
|
|
767
|
-
ratio:
|
|
768
|
-
anyOf:
|
|
769
|
-
- type: number
|
|
770
|
-
- type: 'null'
|
|
771
|
-
title: Ratio
|
|
772
|
-
title: BrandingDesignContrastCheck
|
|
773
|
-
type: object
|
|
774
687
|
BrandingDesignDiff:
|
|
775
688
|
properties:
|
|
776
689
|
changed_paths:
|
|
@@ -789,61 +702,6 @@ components:
|
|
|
789
702
|
additionalProperties: true
|
|
790
703
|
title: BrandingDesignDocument
|
|
791
704
|
type: object
|
|
792
|
-
BrandingDesignNotice:
|
|
793
|
-
properties:
|
|
794
|
-
code:
|
|
795
|
-
title: Code
|
|
796
|
-
type: string
|
|
797
|
-
message:
|
|
798
|
-
default: ''
|
|
799
|
-
title: Message
|
|
800
|
-
type: string
|
|
801
|
-
params:
|
|
802
|
-
additionalProperties:
|
|
803
|
-
anyOf:
|
|
804
|
-
- type: string
|
|
805
|
-
- type: integer
|
|
806
|
-
- type: number
|
|
807
|
-
- type: boolean
|
|
808
|
-
- items:
|
|
809
|
-
type: string
|
|
810
|
-
type: array
|
|
811
|
-
title: Params
|
|
812
|
-
type: object
|
|
813
|
-
severity:
|
|
814
|
-
title: Severity
|
|
815
|
-
type: string
|
|
816
|
-
variants:
|
|
817
|
-
items:
|
|
818
|
-
type: string
|
|
819
|
-
title: Variants
|
|
820
|
-
type: array
|
|
821
|
-
required:
|
|
822
|
-
- code
|
|
823
|
-
- severity
|
|
824
|
-
title: BrandingDesignNotice
|
|
825
|
-
type: object
|
|
826
|
-
BrandingDesignPhrase:
|
|
827
|
-
properties:
|
|
828
|
-
code:
|
|
829
|
-
title: Code
|
|
830
|
-
type: string
|
|
831
|
-
params:
|
|
832
|
-
additionalProperties:
|
|
833
|
-
anyOf:
|
|
834
|
-
- type: string
|
|
835
|
-
- type: integer
|
|
836
|
-
- type: number
|
|
837
|
-
- type: boolean
|
|
838
|
-
- items:
|
|
839
|
-
type: string
|
|
840
|
-
type: array
|
|
841
|
-
title: Params
|
|
842
|
-
type: object
|
|
843
|
-
required:
|
|
844
|
-
- code
|
|
845
|
-
title: BrandingDesignPhrase
|
|
846
|
-
type: object
|
|
847
705
|
BrandingDesignPreview:
|
|
848
706
|
properties:
|
|
849
707
|
dark_strategy:
|
|
@@ -894,11 +752,6 @@ components:
|
|
|
894
752
|
type: object
|
|
895
753
|
BrandingDesignSource:
|
|
896
754
|
properties:
|
|
897
|
-
confidence:
|
|
898
|
-
anyOf:
|
|
899
|
-
- type: string
|
|
900
|
-
- type: 'null'
|
|
901
|
-
title: Confidence
|
|
902
755
|
kind:
|
|
903
756
|
anyOf:
|
|
904
757
|
- type: string
|
|
@@ -942,34 +795,12 @@ components:
|
|
|
942
795
|
type: object
|
|
943
796
|
BrandingDesignVariant:
|
|
944
797
|
properties:
|
|
945
|
-
changed_seeds:
|
|
946
|
-
items:
|
|
947
|
-
type: string
|
|
948
|
-
title: Changed Seeds
|
|
949
|
-
type: array
|
|
950
|
-
contrast:
|
|
951
|
-
anyOf:
|
|
952
|
-
- $ref: '#/components/schemas/BrandingDesignContrast'
|
|
953
|
-
- type: 'null'
|
|
954
798
|
document:
|
|
955
799
|
$ref: '#/components/schemas/BrandingDesignDocument'
|
|
956
|
-
label:
|
|
957
|
-
default: ''
|
|
958
|
-
title: Label
|
|
959
|
-
type: string
|
|
960
800
|
preview:
|
|
961
801
|
anyOf:
|
|
962
802
|
- $ref: '#/components/schemas/BrandingDesignPreview'
|
|
963
803
|
- type: 'null'
|
|
964
|
-
rationale:
|
|
965
|
-
default: ''
|
|
966
|
-
title: Rationale
|
|
967
|
-
type: string
|
|
968
|
-
rationale_parts:
|
|
969
|
-
items:
|
|
970
|
-
$ref: '#/components/schemas/BrandingDesignPhrase'
|
|
971
|
-
title: Rationale Parts
|
|
972
|
-
type: array
|
|
973
804
|
variant_id:
|
|
974
805
|
title: Variant Id
|
|
975
806
|
type: string
|
|
@@ -25000,7 +24831,7 @@ info:
|
|
|
25000
24831
|
\n\n"
|
|
25001
24832
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
25002
24833
|
title: OpusDNS API
|
|
25003
|
-
version: 2026-10-
|
|
24834
|
+
version: 2026-10-02-161543
|
|
25004
24835
|
x-logo:
|
|
25005
24836
|
altText: OpusDNS API Reference
|
|
25006
24837
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -26316,44 +26147,59 @@ paths:
|
|
|
26316
26147
|
title: Email Forward Id
|
|
26317
26148
|
type: string
|
|
26318
26149
|
x-typeid-prefix: email_forward
|
|
26319
|
-
-
|
|
26150
|
+
- description: Sort field (log_id, domain, sender_email, recipient_email, forward_email,
|
|
26151
|
+
final_status, created_on, synced_on)
|
|
26152
|
+
in: query
|
|
26320
26153
|
name: sort_by
|
|
26321
26154
|
required: false
|
|
26322
26155
|
schema:
|
|
26323
26156
|
$ref: '#/components/schemas/EmailForwardLogSortField'
|
|
26324
26157
|
default: created_on
|
|
26325
|
-
|
|
26158
|
+
description: Sort field (log_id, domain, sender_email, recipient_email,
|
|
26159
|
+
forward_email, final_status, created_on, synced_on)
|
|
26160
|
+
- description: Sort order (asc, desc)
|
|
26161
|
+
in: query
|
|
26326
26162
|
name: sort_order
|
|
26327
26163
|
required: false
|
|
26328
26164
|
schema:
|
|
26329
26165
|
$ref: '#/components/schemas/SortOrder'
|
|
26330
26166
|
default: desc
|
|
26331
|
-
|
|
26167
|
+
description: Sort order (asc, desc)
|
|
26168
|
+
- description: Records per page
|
|
26169
|
+
in: query
|
|
26332
26170
|
name: page_size
|
|
26333
26171
|
required: false
|
|
26334
26172
|
schema:
|
|
26335
26173
|
default: 50
|
|
26174
|
+
description: Records per page
|
|
26336
26175
|
maximum: 1000
|
|
26337
26176
|
minimum: 1
|
|
26338
26177
|
title: Page Size
|
|
26339
26178
|
type: integer
|
|
26340
|
-
-
|
|
26179
|
+
- description: Page number
|
|
26180
|
+
in: query
|
|
26341
26181
|
name: page
|
|
26342
26182
|
required: false
|
|
26343
26183
|
schema:
|
|
26344
26184
|
default: 1
|
|
26185
|
+
description: Page number
|
|
26345
26186
|
minimum: 1
|
|
26346
26187
|
title: Page
|
|
26347
26188
|
type: integer
|
|
26348
|
-
-
|
|
26189
|
+
- description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
|
|
26190
|
+
HARD-BOUNCE)
|
|
26191
|
+
in: query
|
|
26349
26192
|
name: final_status
|
|
26350
26193
|
required: false
|
|
26351
26194
|
schema:
|
|
26352
26195
|
anyOf:
|
|
26353
26196
|
- $ref: '#/components/schemas/EmailForwardLogStatus'
|
|
26354
26197
|
- type: 'null'
|
|
26198
|
+
description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
|
|
26199
|
+
HARD-BOUNCE)
|
|
26355
26200
|
title: Final Status
|
|
26356
|
-
-
|
|
26201
|
+
- description: Filter logs after (RFC3339)
|
|
26202
|
+
in: query
|
|
26357
26203
|
name: start_time
|
|
26358
26204
|
required: false
|
|
26359
26205
|
schema:
|
|
@@ -26361,8 +26207,10 @@ paths:
|
|
|
26361
26207
|
- format: date-time
|
|
26362
26208
|
type: string
|
|
26363
26209
|
- type: 'null'
|
|
26210
|
+
description: Filter logs after (RFC3339)
|
|
26364
26211
|
title: Start Time
|
|
26365
|
-
-
|
|
26212
|
+
- description: Filter logs before (RFC3339)
|
|
26213
|
+
in: query
|
|
26366
26214
|
name: end_time
|
|
26367
26215
|
required: false
|
|
26368
26216
|
schema:
|
|
@@ -26370,6 +26218,7 @@ paths:
|
|
|
26370
26218
|
- format: date-time
|
|
26371
26219
|
type: string
|
|
26372
26220
|
- type: 'null'
|
|
26221
|
+
description: Filter logs before (RFC3339)
|
|
26373
26222
|
title: End Time
|
|
26374
26223
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
26375
26224
|
responses:
|
|
@@ -26410,44 +26259,59 @@ paths:
|
|
|
26410
26259
|
title: Email Forward Id
|
|
26411
26260
|
type: string
|
|
26412
26261
|
x-typeid-prefix: email_forward
|
|
26413
|
-
-
|
|
26262
|
+
- description: Sort field (log_id, domain, sender_email, recipient_email, forward_email,
|
|
26263
|
+
final_status, created_on, synced_on)
|
|
26264
|
+
in: query
|
|
26414
26265
|
name: sort_by
|
|
26415
26266
|
required: false
|
|
26416
26267
|
schema:
|
|
26417
26268
|
$ref: '#/components/schemas/EmailForwardLogSortField'
|
|
26418
26269
|
default: created_on
|
|
26419
|
-
|
|
26270
|
+
description: Sort field (log_id, domain, sender_email, recipient_email,
|
|
26271
|
+
forward_email, final_status, created_on, synced_on)
|
|
26272
|
+
- description: Sort order (asc, desc)
|
|
26273
|
+
in: query
|
|
26420
26274
|
name: sort_order
|
|
26421
26275
|
required: false
|
|
26422
26276
|
schema:
|
|
26423
26277
|
$ref: '#/components/schemas/SortOrder'
|
|
26424
26278
|
default: desc
|
|
26425
|
-
|
|
26279
|
+
description: Sort order (asc, desc)
|
|
26280
|
+
- description: Records per page
|
|
26281
|
+
in: query
|
|
26426
26282
|
name: page_size
|
|
26427
26283
|
required: false
|
|
26428
26284
|
schema:
|
|
26429
26285
|
default: 50
|
|
26286
|
+
description: Records per page
|
|
26430
26287
|
maximum: 1000
|
|
26431
26288
|
minimum: 1
|
|
26432
26289
|
title: Page Size
|
|
26433
26290
|
type: integer
|
|
26434
|
-
-
|
|
26291
|
+
- description: Page number
|
|
26292
|
+
in: query
|
|
26435
26293
|
name: page
|
|
26436
26294
|
required: false
|
|
26437
26295
|
schema:
|
|
26438
26296
|
default: 1
|
|
26297
|
+
description: Page number
|
|
26439
26298
|
minimum: 1
|
|
26440
26299
|
title: Page
|
|
26441
26300
|
type: integer
|
|
26442
|
-
-
|
|
26301
|
+
- description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
|
|
26302
|
+
HARD-BOUNCE)
|
|
26303
|
+
in: query
|
|
26443
26304
|
name: final_status
|
|
26444
26305
|
required: false
|
|
26445
26306
|
schema:
|
|
26446
26307
|
anyOf:
|
|
26447
26308
|
- $ref: '#/components/schemas/EmailForwardLogStatus'
|
|
26448
26309
|
- type: 'null'
|
|
26310
|
+
description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
|
|
26311
|
+
HARD-BOUNCE)
|
|
26449
26312
|
title: Final Status
|
|
26450
|
-
-
|
|
26313
|
+
- description: Filter logs after (RFC3339)
|
|
26314
|
+
in: query
|
|
26451
26315
|
name: start_time
|
|
26452
26316
|
required: false
|
|
26453
26317
|
schema:
|
|
@@ -26455,8 +26319,10 @@ paths:
|
|
|
26455
26319
|
- format: date-time
|
|
26456
26320
|
type: string
|
|
26457
26321
|
- type: 'null'
|
|
26322
|
+
description: Filter logs after (RFC3339)
|
|
26458
26323
|
title: Start Time
|
|
26459
|
-
-
|
|
26324
|
+
- description: Filter logs before (RFC3339)
|
|
26325
|
+
in: query
|
|
26460
26326
|
name: end_time
|
|
26461
26327
|
required: false
|
|
26462
26328
|
schema:
|
|
@@ -26464,6 +26330,7 @@ paths:
|
|
|
26464
26330
|
- format: date-time
|
|
26465
26331
|
type: string
|
|
26466
26332
|
- type: 'null'
|
|
26333
|
+
description: Filter logs before (RFC3339)
|
|
26467
26334
|
title: End Time
|
|
26468
26335
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
26469
26336
|
responses:
|
|
@@ -26492,84 +26359,107 @@ paths:
|
|
|
26492
26359
|
description: Retrieve all paginated audit logs with optional filtering and sorting
|
|
26493
26360
|
operationId: get_object_logs_v1_archive_object_logs_get
|
|
26494
26361
|
parameters:
|
|
26495
|
-
-
|
|
26362
|
+
- description: Sort field (object_log_id, object_id, object_type, action, created_on,
|
|
26363
|
+
organization_id, server_request_id, performed_by_type, performed_by_id)
|
|
26364
|
+
in: query
|
|
26496
26365
|
name: sort_by
|
|
26497
26366
|
required: false
|
|
26498
26367
|
schema:
|
|
26499
26368
|
$ref: '#/components/schemas/ObjectLogSortField'
|
|
26500
26369
|
default: created_on
|
|
26501
|
-
|
|
26370
|
+
description: Sort field (object_log_id, object_id, object_type, action,
|
|
26371
|
+
created_on, organization_id, server_request_id, performed_by_type, performed_by_id)
|
|
26372
|
+
- description: Sort order (asc, desc)
|
|
26373
|
+
in: query
|
|
26502
26374
|
name: sort_order
|
|
26503
26375
|
required: false
|
|
26504
26376
|
schema:
|
|
26505
26377
|
$ref: '#/components/schemas/SortOrder'
|
|
26506
26378
|
default: desc
|
|
26507
|
-
|
|
26379
|
+
description: Sort order (asc, desc)
|
|
26380
|
+
- description: Records per page
|
|
26381
|
+
in: query
|
|
26508
26382
|
name: page_size
|
|
26509
26383
|
required: false
|
|
26510
26384
|
schema:
|
|
26511
26385
|
default: 50
|
|
26386
|
+
description: Records per page
|
|
26512
26387
|
maximum: 1000
|
|
26513
26388
|
minimum: 1
|
|
26514
26389
|
title: Page Size
|
|
26515
26390
|
type: integer
|
|
26516
|
-
-
|
|
26391
|
+
- description: Page number
|
|
26392
|
+
in: query
|
|
26517
26393
|
name: page
|
|
26518
26394
|
required: false
|
|
26519
26395
|
schema:
|
|
26520
26396
|
default: 1
|
|
26397
|
+
description: Page number
|
|
26521
26398
|
minimum: 1
|
|
26522
26399
|
title: Page
|
|
26523
26400
|
type: integer
|
|
26524
|
-
-
|
|
26401
|
+
- description: Filter by specific log UUID
|
|
26402
|
+
in: query
|
|
26525
26403
|
name: object_log_id
|
|
26526
26404
|
required: false
|
|
26527
26405
|
schema:
|
|
26528
26406
|
anyOf:
|
|
26529
26407
|
- type: string
|
|
26530
26408
|
- type: 'null'
|
|
26409
|
+
description: Filter by specific log UUID
|
|
26531
26410
|
title: Object Log Id
|
|
26532
|
-
-
|
|
26411
|
+
- description: Filter by object type
|
|
26412
|
+
in: query
|
|
26533
26413
|
name: object_type
|
|
26534
26414
|
required: false
|
|
26535
26415
|
schema:
|
|
26536
26416
|
anyOf:
|
|
26537
26417
|
- type: string
|
|
26538
26418
|
- type: 'null'
|
|
26419
|
+
description: Filter by object type
|
|
26539
26420
|
title: Object Type
|
|
26540
|
-
-
|
|
26421
|
+
- description: Filter by action
|
|
26422
|
+
in: query
|
|
26541
26423
|
name: action
|
|
26542
26424
|
required: false
|
|
26543
26425
|
schema:
|
|
26544
26426
|
anyOf:
|
|
26545
26427
|
- $ref: '#/components/schemas/ObjectEventType'
|
|
26546
26428
|
- type: 'null'
|
|
26429
|
+
description: Filter by action
|
|
26547
26430
|
title: Action
|
|
26548
|
-
-
|
|
26431
|
+
- description: Filter by server request ID
|
|
26432
|
+
in: query
|
|
26549
26433
|
name: server_request_id
|
|
26550
26434
|
required: false
|
|
26551
26435
|
schema:
|
|
26552
26436
|
anyOf:
|
|
26553
26437
|
- type: string
|
|
26554
26438
|
- type: 'null'
|
|
26439
|
+
description: Filter by server request ID
|
|
26555
26440
|
title: Server Request Id
|
|
26556
|
-
-
|
|
26441
|
+
- description: Filter by performer type
|
|
26442
|
+
in: query
|
|
26557
26443
|
name: performed_by_type
|
|
26558
26444
|
required: false
|
|
26559
26445
|
schema:
|
|
26560
26446
|
anyOf:
|
|
26561
26447
|
- $ref: '#/components/schemas/ExecutingEntity'
|
|
26562
26448
|
- type: 'null'
|
|
26449
|
+
description: Filter by performer type
|
|
26563
26450
|
title: Performed By Type
|
|
26564
|
-
-
|
|
26451
|
+
- description: Filter by performer ID (TypeID)
|
|
26452
|
+
in: query
|
|
26565
26453
|
name: performed_by_id
|
|
26566
26454
|
required: false
|
|
26567
26455
|
schema:
|
|
26568
26456
|
anyOf:
|
|
26569
26457
|
- type: string
|
|
26570
26458
|
- type: 'null'
|
|
26459
|
+
description: Filter by performer ID (TypeID)
|
|
26571
26460
|
title: Performed By Id
|
|
26572
|
-
-
|
|
26461
|
+
- description: 'Upper bound: created_on <= value (RFC3339)'
|
|
26462
|
+
in: query
|
|
26573
26463
|
name: created_before
|
|
26574
26464
|
required: false
|
|
26575
26465
|
schema:
|
|
@@ -26577,8 +26467,10 @@ paths:
|
|
|
26577
26467
|
- format: date-time
|
|
26578
26468
|
type: string
|
|
26579
26469
|
- type: 'null'
|
|
26470
|
+
description: 'Upper bound: created_on <= value (RFC3339)'
|
|
26580
26471
|
title: Created Before
|
|
26581
|
-
-
|
|
26472
|
+
- description: 'Lower bound: created_on >= value (RFC3339)'
|
|
26473
|
+
in: query
|
|
26582
26474
|
name: created_after
|
|
26583
26475
|
required: false
|
|
26584
26476
|
schema:
|
|
@@ -26586,14 +26478,17 @@ paths:
|
|
|
26586
26478
|
- format: date-time
|
|
26587
26479
|
type: string
|
|
26588
26480
|
- type: 'null'
|
|
26481
|
+
description: 'Lower bound: created_on >= value (RFC3339)'
|
|
26589
26482
|
title: Created After
|
|
26590
|
-
-
|
|
26483
|
+
- description: Filter by object ID (TypeID)
|
|
26484
|
+
in: query
|
|
26591
26485
|
name: object_id
|
|
26592
26486
|
required: false
|
|
26593
26487
|
schema:
|
|
26594
26488
|
anyOf:
|
|
26595
26489
|
- type: string
|
|
26596
26490
|
- type: 'null'
|
|
26491
|
+
description: Filter by object ID (TypeID)
|
|
26597
26492
|
title: Object Id
|
|
26598
26493
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
26599
26494
|
responses:
|
|
@@ -26629,84 +26524,107 @@ paths:
|
|
|
26629
26524
|
schema:
|
|
26630
26525
|
title: Object Id
|
|
26631
26526
|
type: string
|
|
26632
|
-
-
|
|
26527
|
+
- description: Sort field (object_log_id, object_id, object_type, action, created_on,
|
|
26528
|
+
organization_id, server_request_id, performed_by_type, performed_by_id)
|
|
26529
|
+
in: query
|
|
26633
26530
|
name: sort_by
|
|
26634
26531
|
required: false
|
|
26635
26532
|
schema:
|
|
26636
26533
|
$ref: '#/components/schemas/ObjectLogSortField'
|
|
26637
26534
|
default: created_on
|
|
26638
|
-
|
|
26535
|
+
description: Sort field (object_log_id, object_id, object_type, action,
|
|
26536
|
+
created_on, organization_id, server_request_id, performed_by_type, performed_by_id)
|
|
26537
|
+
- description: Sort order (asc, desc)
|
|
26538
|
+
in: query
|
|
26639
26539
|
name: sort_order
|
|
26640
26540
|
required: false
|
|
26641
26541
|
schema:
|
|
26642
26542
|
$ref: '#/components/schemas/SortOrder'
|
|
26643
26543
|
default: desc
|
|
26644
|
-
|
|
26544
|
+
description: Sort order (asc, desc)
|
|
26545
|
+
- description: Records per page
|
|
26546
|
+
in: query
|
|
26645
26547
|
name: page_size
|
|
26646
26548
|
required: false
|
|
26647
26549
|
schema:
|
|
26648
26550
|
default: 50
|
|
26551
|
+
description: Records per page
|
|
26649
26552
|
maximum: 1000
|
|
26650
26553
|
minimum: 1
|
|
26651
26554
|
title: Page Size
|
|
26652
26555
|
type: integer
|
|
26653
|
-
-
|
|
26556
|
+
- description: Page number
|
|
26557
|
+
in: query
|
|
26654
26558
|
name: page
|
|
26655
26559
|
required: false
|
|
26656
26560
|
schema:
|
|
26657
26561
|
default: 1
|
|
26562
|
+
description: Page number
|
|
26658
26563
|
minimum: 1
|
|
26659
26564
|
title: Page
|
|
26660
26565
|
type: integer
|
|
26661
|
-
-
|
|
26566
|
+
- description: Filter by specific log UUID
|
|
26567
|
+
in: query
|
|
26662
26568
|
name: object_log_id
|
|
26663
26569
|
required: false
|
|
26664
26570
|
schema:
|
|
26665
26571
|
anyOf:
|
|
26666
26572
|
- type: string
|
|
26667
26573
|
- type: 'null'
|
|
26574
|
+
description: Filter by specific log UUID
|
|
26668
26575
|
title: Object Log Id
|
|
26669
|
-
-
|
|
26576
|
+
- description: Filter by object type
|
|
26577
|
+
in: query
|
|
26670
26578
|
name: object_type
|
|
26671
26579
|
required: false
|
|
26672
26580
|
schema:
|
|
26673
26581
|
anyOf:
|
|
26674
26582
|
- type: string
|
|
26675
26583
|
- type: 'null'
|
|
26584
|
+
description: Filter by object type
|
|
26676
26585
|
title: Object Type
|
|
26677
|
-
-
|
|
26586
|
+
- description: Filter by action
|
|
26587
|
+
in: query
|
|
26678
26588
|
name: action
|
|
26679
26589
|
required: false
|
|
26680
26590
|
schema:
|
|
26681
26591
|
anyOf:
|
|
26682
26592
|
- $ref: '#/components/schemas/ObjectEventType'
|
|
26683
26593
|
- type: 'null'
|
|
26594
|
+
description: Filter by action
|
|
26684
26595
|
title: Action
|
|
26685
|
-
-
|
|
26596
|
+
- description: Filter by server request ID
|
|
26597
|
+
in: query
|
|
26686
26598
|
name: server_request_id
|
|
26687
26599
|
required: false
|
|
26688
26600
|
schema:
|
|
26689
26601
|
anyOf:
|
|
26690
26602
|
- type: string
|
|
26691
26603
|
- type: 'null'
|
|
26604
|
+
description: Filter by server request ID
|
|
26692
26605
|
title: Server Request Id
|
|
26693
|
-
-
|
|
26606
|
+
- description: Filter by performer type
|
|
26607
|
+
in: query
|
|
26694
26608
|
name: performed_by_type
|
|
26695
26609
|
required: false
|
|
26696
26610
|
schema:
|
|
26697
26611
|
anyOf:
|
|
26698
26612
|
- $ref: '#/components/schemas/ExecutingEntity'
|
|
26699
26613
|
- type: 'null'
|
|
26614
|
+
description: Filter by performer type
|
|
26700
26615
|
title: Performed By Type
|
|
26701
|
-
-
|
|
26616
|
+
- description: Filter by performer ID (TypeID)
|
|
26617
|
+
in: query
|
|
26702
26618
|
name: performed_by_id
|
|
26703
26619
|
required: false
|
|
26704
26620
|
schema:
|
|
26705
26621
|
anyOf:
|
|
26706
26622
|
- type: string
|
|
26707
26623
|
- type: 'null'
|
|
26624
|
+
description: Filter by performer ID (TypeID)
|
|
26708
26625
|
title: Performed By Id
|
|
26709
|
-
-
|
|
26626
|
+
- description: 'Upper bound: created_on <= value (RFC3339)'
|
|
26627
|
+
in: query
|
|
26710
26628
|
name: created_before
|
|
26711
26629
|
required: false
|
|
26712
26630
|
schema:
|
|
@@ -26714,8 +26632,10 @@ paths:
|
|
|
26714
26632
|
- format: date-time
|
|
26715
26633
|
type: string
|
|
26716
26634
|
- type: 'null'
|
|
26635
|
+
description: 'Upper bound: created_on <= value (RFC3339)'
|
|
26717
26636
|
title: Created Before
|
|
26718
|
-
-
|
|
26637
|
+
- description: 'Lower bound: created_on >= value (RFC3339)'
|
|
26638
|
+
in: query
|
|
26719
26639
|
name: created_after
|
|
26720
26640
|
required: false
|
|
26721
26641
|
schema:
|
|
@@ -26723,6 +26643,7 @@ paths:
|
|
|
26723
26643
|
- format: date-time
|
|
26724
26644
|
type: string
|
|
26725
26645
|
- type: 'null'
|
|
26646
|
+
description: 'Lower bound: created_on >= value (RFC3339)'
|
|
26726
26647
|
title: Created After
|
|
26727
26648
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
26728
26649
|
responses:
|
|
@@ -26751,18 +26672,26 @@ paths:
|
|
|
26751
26672
|
description: Retrieves a paginated list of request history logs
|
|
26752
26673
|
operationId: get_request_history_v1_archive_request_history_get
|
|
26753
26674
|
parameters:
|
|
26754
|
-
-
|
|
26675
|
+
- description: Sort field (request_history_id, method, path, status_code, duration,
|
|
26676
|
+
client_ip, server_request_id, performed_by_type, performed_by_id, created_on,
|
|
26677
|
+
request_started_at, request_completed_at, organization_id)
|
|
26678
|
+
in: query
|
|
26755
26679
|
name: sort_by
|
|
26756
26680
|
required: false
|
|
26757
26681
|
schema:
|
|
26758
26682
|
$ref: '#/components/schemas/RequestHistorySortField'
|
|
26759
26683
|
default: created_on
|
|
26760
|
-
|
|
26684
|
+
description: Sort field (request_history_id, method, path, status_code,
|
|
26685
|
+
duration, client_ip, server_request_id, performed_by_type, performed_by_id,
|
|
26686
|
+
created_on, request_started_at, request_completed_at, organization_id)
|
|
26687
|
+
- description: Sort order (asc, desc)
|
|
26688
|
+
in: query
|
|
26761
26689
|
name: sort_order
|
|
26762
26690
|
required: false
|
|
26763
26691
|
schema:
|
|
26764
26692
|
$ref: '#/components/schemas/SortOrder'
|
|
26765
26693
|
default: desc
|
|
26694
|
+
description: Sort order (asc, desc)
|
|
26766
26695
|
- in: query
|
|
26767
26696
|
name: page_size
|
|
26768
26697
|
required: false
|
|
@@ -26780,63 +26709,78 @@ paths:
|
|
|
26780
26709
|
minimum: 1
|
|
26781
26710
|
title: Page
|
|
26782
26711
|
type: integer
|
|
26783
|
-
-
|
|
26712
|
+
- description: HTTP method filter (GET, POST, etc.)
|
|
26713
|
+
in: query
|
|
26784
26714
|
name: method
|
|
26785
26715
|
required: false
|
|
26786
26716
|
schema:
|
|
26787
26717
|
anyOf:
|
|
26788
26718
|
- $ref: '#/components/schemas/HTTPMethod'
|
|
26789
26719
|
- type: 'null'
|
|
26720
|
+
description: HTTP method filter (GET, POST, etc.)
|
|
26790
26721
|
title: Method
|
|
26791
|
-
-
|
|
26722
|
+
- description: Path filter (supports LIKE queries)
|
|
26723
|
+
in: query
|
|
26792
26724
|
name: path
|
|
26793
26725
|
required: false
|
|
26794
26726
|
schema:
|
|
26795
26727
|
anyOf:
|
|
26796
26728
|
- type: string
|
|
26797
26729
|
- type: 'null'
|
|
26730
|
+
description: Path filter (supports LIKE queries)
|
|
26798
26731
|
title: Path
|
|
26799
|
-
-
|
|
26732
|
+
- description: Exact status code filter
|
|
26733
|
+
in: query
|
|
26800
26734
|
name: status_code
|
|
26801
26735
|
required: false
|
|
26802
26736
|
schema:
|
|
26803
26737
|
anyOf:
|
|
26804
26738
|
- type: integer
|
|
26805
26739
|
- type: 'null'
|
|
26740
|
+
description: Exact status code filter
|
|
26806
26741
|
title: Status Code
|
|
26807
|
-
-
|
|
26742
|
+
- description: Minimum status code filter
|
|
26743
|
+
in: query
|
|
26808
26744
|
name: min_status_code
|
|
26809
26745
|
required: false
|
|
26810
26746
|
schema:
|
|
26811
26747
|
anyOf:
|
|
26812
26748
|
- type: integer
|
|
26813
26749
|
- type: 'null'
|
|
26750
|
+
description: Minimum status code filter
|
|
26814
26751
|
title: Min Status Code
|
|
26815
|
-
-
|
|
26752
|
+
- description: Maximum status code filter
|
|
26753
|
+
in: query
|
|
26816
26754
|
name: max_status_code
|
|
26817
26755
|
required: false
|
|
26818
26756
|
schema:
|
|
26819
26757
|
anyOf:
|
|
26820
26758
|
- type: integer
|
|
26821
26759
|
- type: 'null'
|
|
26760
|
+
description: Maximum status code filter
|
|
26822
26761
|
title: Max Status Code
|
|
26823
|
-
-
|
|
26762
|
+
- description: Minimum duration in milliseconds
|
|
26763
|
+
in: query
|
|
26824
26764
|
name: min_duration
|
|
26825
26765
|
required: false
|
|
26826
26766
|
schema:
|
|
26827
26767
|
anyOf:
|
|
26828
26768
|
- type: number
|
|
26829
26769
|
- type: 'null'
|
|
26770
|
+
description: Minimum duration in milliseconds
|
|
26830
26771
|
title: Min Duration
|
|
26831
|
-
-
|
|
26772
|
+
- description: Maximum duration in milliseconds
|
|
26773
|
+
in: query
|
|
26832
26774
|
name: max_duration
|
|
26833
26775
|
required: false
|
|
26834
26776
|
schema:
|
|
26835
26777
|
anyOf:
|
|
26836
26778
|
- type: number
|
|
26837
26779
|
- type: 'null'
|
|
26780
|
+
description: Maximum duration in milliseconds
|
|
26838
26781
|
title: Max Duration
|
|
26839
|
-
-
|
|
26782
|
+
- description: Client IP address filter
|
|
26783
|
+
in: query
|
|
26840
26784
|
name: client_ip
|
|
26841
26785
|
required: false
|
|
26842
26786
|
schema:
|
|
@@ -26844,32 +26788,40 @@ paths:
|
|
|
26844
26788
|
- format: ipvanyaddress
|
|
26845
26789
|
type: string
|
|
26846
26790
|
- type: 'null'
|
|
26791
|
+
description: Client IP address filter
|
|
26847
26792
|
title: Client Ip
|
|
26848
|
-
-
|
|
26793
|
+
- description: Server request ID filter
|
|
26794
|
+
in: query
|
|
26849
26795
|
name: server_request_id
|
|
26850
26796
|
required: false
|
|
26851
26797
|
schema:
|
|
26852
26798
|
anyOf:
|
|
26853
26799
|
- type: string
|
|
26854
26800
|
- type: 'null'
|
|
26801
|
+
description: Server request ID filter
|
|
26855
26802
|
title: Server Request Id
|
|
26856
|
-
-
|
|
26803
|
+
- description: Performed by type filter
|
|
26804
|
+
in: query
|
|
26857
26805
|
name: performed_by_type
|
|
26858
26806
|
required: false
|
|
26859
26807
|
schema:
|
|
26860
26808
|
anyOf:
|
|
26861
26809
|
- $ref: '#/components/schemas/ExecutingEntity'
|
|
26862
26810
|
- type: 'null'
|
|
26811
|
+
description: Performed by type filter
|
|
26863
26812
|
title: Performed By Type
|
|
26864
|
-
-
|
|
26813
|
+
- description: Performed by ID filter
|
|
26814
|
+
in: query
|
|
26865
26815
|
name: performed_by_id
|
|
26866
26816
|
required: false
|
|
26867
26817
|
schema:
|
|
26868
26818
|
anyOf:
|
|
26869
26819
|
- type: string
|
|
26870
26820
|
- type: 'null'
|
|
26821
|
+
description: Performed by ID filter
|
|
26871
26822
|
title: Performed By Id
|
|
26872
|
-
-
|
|
26823
|
+
- description: 'Upper bound: request_started_at <= value (RFC3339)'
|
|
26824
|
+
in: query
|
|
26873
26825
|
name: request_started_before
|
|
26874
26826
|
required: false
|
|
26875
26827
|
schema:
|
|
@@ -26877,8 +26829,10 @@ paths:
|
|
|
26877
26829
|
- format: date-time
|
|
26878
26830
|
type: string
|
|
26879
26831
|
- type: 'null'
|
|
26832
|
+
description: 'Upper bound: request_started_at <= value (RFC3339)'
|
|
26880
26833
|
title: Request Started Before
|
|
26881
|
-
-
|
|
26834
|
+
- description: 'Lower bound: request_started_at >= value (RFC3339)'
|
|
26835
|
+
in: query
|
|
26882
26836
|
name: request_started_after
|
|
26883
26837
|
required: false
|
|
26884
26838
|
schema:
|
|
@@ -26886,6 +26840,7 @@ paths:
|
|
|
26886
26840
|
- format: date-time
|
|
26887
26841
|
type: string
|
|
26888
26842
|
- type: 'null'
|
|
26843
|
+
description: 'Lower bound: request_started_at >= value (RFC3339)'
|
|
26889
26844
|
title: Request Started After
|
|
26890
26845
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
26891
26846
|
responses:
|
|
@@ -27271,18 +27226,22 @@ paths:
|
|
|
27271
27226
|
minimum: 1
|
|
27272
27227
|
title: Page Size
|
|
27273
27228
|
type: integer
|
|
27274
|
-
-
|
|
27229
|
+
- description: Field to sort by
|
|
27230
|
+
in: query
|
|
27275
27231
|
name: sort_by
|
|
27276
27232
|
required: false
|
|
27277
27233
|
schema:
|
|
27278
27234
|
$ref: '#/components/schemas/ContactSortField'
|
|
27279
27235
|
default: created_on
|
|
27280
|
-
|
|
27236
|
+
description: Field to sort by
|
|
27237
|
+
- description: Sort order direction
|
|
27238
|
+
in: query
|
|
27281
27239
|
name: sort_order
|
|
27282
27240
|
required: false
|
|
27283
27241
|
schema:
|
|
27284
27242
|
$ref: '#/components/schemas/SortOrder'
|
|
27285
27243
|
default: desc
|
|
27244
|
+
description: Sort order direction
|
|
27286
27245
|
- description: Filter by contact status tag types. Can be specified multiple
|
|
27287
27246
|
times.
|
|
27288
27247
|
in: query
|
|
@@ -27297,12 +27256,22 @@ paths:
|
|
|
27297
27256
|
description: Filter by contact status tag types. Can be specified multiple
|
|
27298
27257
|
times.
|
|
27299
27258
|
title: Status Tags
|
|
27300
|
-
-
|
|
27259
|
+
- description: 'How to combine status_tags: ''match_any'' returns objects with
|
|
27260
|
+
at least one of the tags, ''match_all'' returns objects with every tag,
|
|
27261
|
+
''match_none'' returns objects with none of the tags, including objects
|
|
27262
|
+
that carry no status tags at all. Has no effect unless one or more status_tags
|
|
27263
|
+
are supplied.'
|
|
27264
|
+
in: query
|
|
27301
27265
|
name: status_tag_mode
|
|
27302
27266
|
required: false
|
|
27303
27267
|
schema:
|
|
27304
27268
|
$ref: '#/components/schemas/TagFilterMode'
|
|
27305
27269
|
default: match_any
|
|
27270
|
+
description: 'How to combine status_tags: ''match_any'' returns objects
|
|
27271
|
+
with at least one of the tags, ''match_all'' returns objects with every
|
|
27272
|
+
tag, ''match_none'' returns objects with none of the tags, including objects
|
|
27273
|
+
that carry no status tags at all. Has no effect unless one or more status_tags
|
|
27274
|
+
are supplied.'
|
|
27306
27275
|
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
27307
27276
|
in: query
|
|
27308
27277
|
name: tag_ids
|
|
@@ -27320,69 +27289,106 @@ paths:
|
|
|
27320
27289
|
- type: 'null'
|
|
27321
27290
|
description: Filter by user tag IDs. Can be specified multiple times.
|
|
27322
27291
|
title: Tag Ids
|
|
27323
|
-
-
|
|
27292
|
+
- description: 'How to combine tag_ids: ''match_any'' returns objects with at
|
|
27293
|
+
least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
|
|
27294
|
+
returns objects with none of the tags, including objects that carry no user
|
|
27295
|
+
tags at all. Has no effect unless one or more tag_ids are supplied; to filter
|
|
27296
|
+
on whether an object has any user tag, use has_tags.'
|
|
27297
|
+
in: query
|
|
27324
27298
|
name: tag_mode
|
|
27325
27299
|
required: false
|
|
27326
27300
|
schema:
|
|
27327
27301
|
$ref: '#/components/schemas/TagFilterMode'
|
|
27328
27302
|
default: match_any
|
|
27329
|
-
|
|
27303
|
+
description: 'How to combine tag_ids: ''match_any'' returns objects with
|
|
27304
|
+
at least one of the tags, ''match_all'' returns objects with every tag,
|
|
27305
|
+
''match_none'' returns objects with none of the tags, including objects
|
|
27306
|
+
that carry no user tags at all. Has no effect unless one or more tag_ids
|
|
27307
|
+
are supplied; to filter on whether an object has any user tag, use has_tags.'
|
|
27308
|
+
- description: true returns only objects that carry at least one user tag, false
|
|
27309
|
+
only objects that carry none. Status tags are not counted. Combines with
|
|
27310
|
+
tag_ids and the other filters.
|
|
27311
|
+
in: query
|
|
27330
27312
|
name: has_tags
|
|
27331
27313
|
required: false
|
|
27332
27314
|
schema:
|
|
27333
27315
|
anyOf:
|
|
27334
27316
|
- type: boolean
|
|
27335
27317
|
- type: 'null'
|
|
27318
|
+
description: true returns only objects that carry at least one user tag,
|
|
27319
|
+
false only objects that carry none. Status tags are not counted. Combines
|
|
27320
|
+
with tag_ids and the other filters.
|
|
27336
27321
|
title: Has Tags
|
|
27337
|
-
-
|
|
27322
|
+
- description: Filter by exact first name
|
|
27323
|
+
in: query
|
|
27338
27324
|
name: first_name
|
|
27339
27325
|
required: false
|
|
27340
27326
|
schema:
|
|
27341
27327
|
anyOf:
|
|
27342
27328
|
- type: string
|
|
27343
27329
|
- type: 'null'
|
|
27330
|
+
description: Filter by exact first name
|
|
27344
27331
|
title: First Name
|
|
27345
|
-
-
|
|
27332
|
+
- description: Filter by exact last name
|
|
27333
|
+
in: query
|
|
27346
27334
|
name: last_name
|
|
27347
27335
|
required: false
|
|
27348
27336
|
schema:
|
|
27349
27337
|
anyOf:
|
|
27350
27338
|
- type: string
|
|
27351
27339
|
- type: 'null'
|
|
27340
|
+
description: Filter by exact last name
|
|
27352
27341
|
title: Last Name
|
|
27353
|
-
-
|
|
27342
|
+
- description: Filter by exact email address
|
|
27343
|
+
in: query
|
|
27354
27344
|
name: email
|
|
27355
27345
|
required: false
|
|
27356
27346
|
schema:
|
|
27357
27347
|
anyOf:
|
|
27358
27348
|
- type: string
|
|
27359
27349
|
- type: 'null'
|
|
27350
|
+
description: Filter by exact email address
|
|
27360
27351
|
title: Email
|
|
27361
|
-
-
|
|
27352
|
+
- description: Search contacts by name, email, organization, or contact ID.
|
|
27353
|
+
Multiple whitespace-separated terms must all match (as substrings), so a
|
|
27354
|
+
full "First Last" name matches across the separate first- and last-name
|
|
27355
|
+
columns. A contact ID is matched exactly.
|
|
27356
|
+
in: query
|
|
27362
27357
|
name: search
|
|
27363
27358
|
required: false
|
|
27364
27359
|
schema:
|
|
27365
27360
|
anyOf:
|
|
27366
27361
|
- type: string
|
|
27367
27362
|
- type: 'null'
|
|
27363
|
+
description: Search contacts by name, email, organization, or contact ID.
|
|
27364
|
+
Multiple whitespace-separated terms must all match (as substrings), so
|
|
27365
|
+
a full "First Last" name matches across the separate first- and last-name
|
|
27366
|
+
columns. A contact ID is matched exactly.
|
|
27368
27367
|
title: Search
|
|
27369
|
-
-
|
|
27368
|
+
- description: Filter by country
|
|
27369
|
+
in: query
|
|
27370
27370
|
name: country
|
|
27371
27371
|
required: false
|
|
27372
27372
|
schema:
|
|
27373
27373
|
anyOf:
|
|
27374
27374
|
- type: string
|
|
27375
27375
|
- type: 'null'
|
|
27376
|
+
description: Filter by country
|
|
27376
27377
|
title: Country
|
|
27377
|
-
-
|
|
27378
|
+
- description: Filter by whether the contact is in use by any domain (true =
|
|
27379
|
+
has domains, false = none)
|
|
27380
|
+
in: query
|
|
27378
27381
|
name: in_use
|
|
27379
27382
|
required: false
|
|
27380
27383
|
schema:
|
|
27381
27384
|
anyOf:
|
|
27382
27385
|
- type: boolean
|
|
27383
27386
|
- type: 'null'
|
|
27387
|
+
description: Filter by whether the contact is in use by any domain (true
|
|
27388
|
+
= has domains, false = none)
|
|
27384
27389
|
title: In Use
|
|
27385
|
-
-
|
|
27390
|
+
- description: Filter contacts created after this date
|
|
27391
|
+
in: query
|
|
27386
27392
|
name: created_after
|
|
27387
27393
|
required: false
|
|
27388
27394
|
schema:
|
|
@@ -27390,8 +27396,10 @@ paths:
|
|
|
27390
27396
|
- format: date-time
|
|
27391
27397
|
type: string
|
|
27392
27398
|
- type: 'null'
|
|
27399
|
+
description: Filter contacts created after this date
|
|
27393
27400
|
title: Created After
|
|
27394
|
-
-
|
|
27401
|
+
- description: Filter contacts created before this date
|
|
27402
|
+
in: query
|
|
27395
27403
|
name: created_before
|
|
27396
27404
|
required: false
|
|
27397
27405
|
schema:
|
|
@@ -27399,6 +27407,7 @@ paths:
|
|
|
27399
27407
|
- format: date-time
|
|
27400
27408
|
type: string
|
|
27401
27409
|
- type: 'null'
|
|
27410
|
+
description: Filter contacts created before this date
|
|
27402
27411
|
title: Created Before
|
|
27403
27412
|
- description: Include additional data in the response. Can be specified multiple
|
|
27404
27413
|
times.
|
|
@@ -27511,33 +27520,41 @@ paths:
|
|
|
27511
27520
|
minimum: 1
|
|
27512
27521
|
title: Page Size
|
|
27513
27522
|
type: integer
|
|
27514
|
-
-
|
|
27523
|
+
- description: Field to sort by
|
|
27524
|
+
in: query
|
|
27515
27525
|
name: sort_by
|
|
27516
27526
|
required: false
|
|
27517
27527
|
schema:
|
|
27518
27528
|
$ref: '#/components/schemas/ContactAttributeSetSortField'
|
|
27519
27529
|
default: created_on
|
|
27520
|
-
|
|
27530
|
+
description: Field to sort by
|
|
27531
|
+
- description: Sort order direction
|
|
27532
|
+
in: query
|
|
27521
27533
|
name: sort_order
|
|
27522
27534
|
required: false
|
|
27523
27535
|
schema:
|
|
27524
27536
|
$ref: '#/components/schemas/SortOrder'
|
|
27525
27537
|
default: desc
|
|
27526
|
-
|
|
27538
|
+
description: Sort order direction
|
|
27539
|
+
- description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
|
|
27540
|
+
in: query
|
|
27527
27541
|
name: tld
|
|
27528
27542
|
required: false
|
|
27529
27543
|
schema:
|
|
27530
27544
|
anyOf:
|
|
27531
27545
|
- type: string
|
|
27532
27546
|
- type: 'null'
|
|
27547
|
+
description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
|
|
27533
27548
|
title: Tld
|
|
27534
|
-
-
|
|
27549
|
+
- description: Filter by label (contains, case-insensitive)
|
|
27550
|
+
in: query
|
|
27535
27551
|
name: label
|
|
27536
27552
|
required: false
|
|
27537
27553
|
schema:
|
|
27538
27554
|
anyOf:
|
|
27539
27555
|
- type: string
|
|
27540
27556
|
- type: 'null'
|
|
27557
|
+
description: Filter by label (contains, case-insensitive)
|
|
27541
27558
|
title: Label
|
|
27542
27559
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
27543
27560
|
responses:
|
|
@@ -28622,18 +28639,22 @@ paths:
|
|
|
28622
28639
|
minimum: 1
|
|
28623
28640
|
title: Page Size
|
|
28624
28641
|
type: integer
|
|
28625
|
-
-
|
|
28642
|
+
- description: Field to sort by
|
|
28643
|
+
in: query
|
|
28626
28644
|
name: sort_by
|
|
28627
28645
|
required: false
|
|
28628
28646
|
schema:
|
|
28629
28647
|
$ref: '#/components/schemas/ZoneSortField'
|
|
28630
28648
|
default: created_on
|
|
28631
|
-
|
|
28649
|
+
description: Field to sort by
|
|
28650
|
+
- description: Sort order direction
|
|
28651
|
+
in: query
|
|
28632
28652
|
name: sort_order
|
|
28633
28653
|
required: false
|
|
28634
28654
|
schema:
|
|
28635
28655
|
$ref: '#/components/schemas/SortOrder'
|
|
28636
28656
|
default: desc
|
|
28657
|
+
description: Sort order direction
|
|
28637
28658
|
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
28638
28659
|
in: query
|
|
28639
28660
|
name: tag_ids
|
|
@@ -28651,53 +28672,78 @@ paths:
|
|
|
28651
28672
|
- type: 'null'
|
|
28652
28673
|
description: Filter by user tag IDs. Can be specified multiple times.
|
|
28653
28674
|
title: Tag Ids
|
|
28654
|
-
-
|
|
28675
|
+
- description: 'How to combine tag_ids: ''match_any'' returns objects with at
|
|
28676
|
+
least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
|
|
28677
|
+
returns objects with none of the tags, including objects that carry no user
|
|
28678
|
+
tags at all. Has no effect unless one or more tag_ids are supplied; to filter
|
|
28679
|
+
on whether an object has any user tag, use has_tags.'
|
|
28680
|
+
in: query
|
|
28655
28681
|
name: tag_mode
|
|
28656
28682
|
required: false
|
|
28657
28683
|
schema:
|
|
28658
28684
|
$ref: '#/components/schemas/TagFilterMode'
|
|
28659
28685
|
default: match_any
|
|
28660
|
-
|
|
28686
|
+
description: 'How to combine tag_ids: ''match_any'' returns objects with
|
|
28687
|
+
at least one of the tags, ''match_all'' returns objects with every tag,
|
|
28688
|
+
''match_none'' returns objects with none of the tags, including objects
|
|
28689
|
+
that carry no user tags at all. Has no effect unless one or more tag_ids
|
|
28690
|
+
are supplied; to filter on whether an object has any user tag, use has_tags.'
|
|
28691
|
+
- description: true returns only objects that carry at least one user tag, false
|
|
28692
|
+
only objects that carry none. Status tags are not counted. Combines with
|
|
28693
|
+
tag_ids and the other filters.
|
|
28694
|
+
in: query
|
|
28661
28695
|
name: has_tags
|
|
28662
28696
|
required: false
|
|
28663
28697
|
schema:
|
|
28664
28698
|
anyOf:
|
|
28665
28699
|
- type: boolean
|
|
28666
28700
|
- type: 'null'
|
|
28701
|
+
description: true returns only objects that carry at least one user tag,
|
|
28702
|
+
false only objects that carry none. Status tags are not counted. Combines
|
|
28703
|
+
with tag_ids and the other filters.
|
|
28667
28704
|
title: Has Tags
|
|
28668
|
-
-
|
|
28705
|
+
- description: Filter by DNSSEC status
|
|
28706
|
+
in: query
|
|
28669
28707
|
name: dnssec_status
|
|
28670
28708
|
required: false
|
|
28671
28709
|
schema:
|
|
28672
28710
|
anyOf:
|
|
28673
28711
|
- $ref: '#/components/schemas/DnssecStatus'
|
|
28674
28712
|
- type: 'null'
|
|
28713
|
+
description: Filter by DNSSEC status
|
|
28675
28714
|
title: Dnssec Status
|
|
28676
|
-
-
|
|
28715
|
+
- description: Filter by exact zone name
|
|
28716
|
+
in: query
|
|
28677
28717
|
name: name
|
|
28678
28718
|
required: false
|
|
28679
28719
|
schema:
|
|
28680
28720
|
anyOf:
|
|
28681
28721
|
- type: string
|
|
28682
28722
|
- type: 'null'
|
|
28723
|
+
description: Filter by exact zone name
|
|
28683
28724
|
title: Name
|
|
28684
|
-
-
|
|
28725
|
+
- description: Search zones by name (contains)
|
|
28726
|
+
in: query
|
|
28685
28727
|
name: search
|
|
28686
28728
|
required: false
|
|
28687
28729
|
schema:
|
|
28688
28730
|
anyOf:
|
|
28689
28731
|
- type: string
|
|
28690
28732
|
- type: 'null'
|
|
28733
|
+
description: Search zones by name (contains)
|
|
28691
28734
|
title: Search
|
|
28692
|
-
-
|
|
28735
|
+
- description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
|
|
28736
|
+
in: query
|
|
28693
28737
|
name: suffix
|
|
28694
28738
|
required: false
|
|
28695
28739
|
schema:
|
|
28696
28740
|
anyOf:
|
|
28697
28741
|
- type: string
|
|
28698
28742
|
- type: 'null'
|
|
28743
|
+
description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
|
|
28699
28744
|
title: Suffix
|
|
28700
|
-
-
|
|
28745
|
+
- description: Filter zones by the vanity nameserver set branding them
|
|
28746
|
+
in: query
|
|
28701
28747
|
name: vanity_nameserver_set_id
|
|
28702
28748
|
required: false
|
|
28703
28749
|
schema:
|
|
@@ -28709,8 +28755,10 @@ paths:
|
|
|
28709
28755
|
type: string
|
|
28710
28756
|
x-typeid-prefix: vns
|
|
28711
28757
|
- type: 'null'
|
|
28758
|
+
description: Filter zones by the vanity nameserver set branding them
|
|
28712
28759
|
title: Vanity Nameserver Set Id
|
|
28713
|
-
-
|
|
28760
|
+
- description: Filter zones created after this date
|
|
28761
|
+
in: query
|
|
28714
28762
|
name: created_after
|
|
28715
28763
|
required: false
|
|
28716
28764
|
schema:
|
|
@@ -28718,8 +28766,10 @@ paths:
|
|
|
28718
28766
|
- format: date-time
|
|
28719
28767
|
type: string
|
|
28720
28768
|
- type: 'null'
|
|
28769
|
+
description: Filter zones created after this date
|
|
28721
28770
|
title: Created After
|
|
28722
|
-
-
|
|
28771
|
+
- description: Filter zones created before this date
|
|
28772
|
+
in: query
|
|
28723
28773
|
name: created_before
|
|
28724
28774
|
required: false
|
|
28725
28775
|
schema:
|
|
@@ -28727,8 +28777,10 @@ paths:
|
|
|
28727
28777
|
- format: date-time
|
|
28728
28778
|
type: string
|
|
28729
28779
|
- type: 'null'
|
|
28780
|
+
description: Filter zones created before this date
|
|
28730
28781
|
title: Created Before
|
|
28731
|
-
-
|
|
28782
|
+
- description: Filter zones updated after this date
|
|
28783
|
+
in: query
|
|
28732
28784
|
name: updated_after
|
|
28733
28785
|
required: false
|
|
28734
28786
|
schema:
|
|
@@ -28736,8 +28788,10 @@ paths:
|
|
|
28736
28788
|
- format: date-time
|
|
28737
28789
|
type: string
|
|
28738
28790
|
- type: 'null'
|
|
28791
|
+
description: Filter zones updated after this date
|
|
28739
28792
|
title: Updated After
|
|
28740
|
-
-
|
|
28793
|
+
- description: Filter zones updated before this date
|
|
28794
|
+
in: query
|
|
28741
28795
|
name: updated_before
|
|
28742
28796
|
required: false
|
|
28743
28797
|
schema:
|
|
@@ -28745,6 +28799,7 @@ paths:
|
|
|
28745
28799
|
- format: date-time
|
|
28746
28800
|
type: string
|
|
28747
28801
|
- type: 'null'
|
|
28802
|
+
description: Filter zones updated before this date
|
|
28748
28803
|
title: Updated Before
|
|
28749
28804
|
- description: Include additional data in the response. Can be specified multiple
|
|
28750
28805
|
times.
|
|
@@ -29133,26 +29188,32 @@ paths:
|
|
|
29133
29188
|
minimum: 1
|
|
29134
29189
|
title: Page Size
|
|
29135
29190
|
type: integer
|
|
29136
|
-
-
|
|
29191
|
+
- description: Search by zone name
|
|
29192
|
+
in: query
|
|
29137
29193
|
name: search
|
|
29138
29194
|
required: false
|
|
29139
29195
|
schema:
|
|
29140
29196
|
anyOf:
|
|
29141
29197
|
- type: string
|
|
29142
29198
|
- type: 'null'
|
|
29199
|
+
description: Search by zone name
|
|
29143
29200
|
title: Search
|
|
29144
|
-
-
|
|
29201
|
+
- description: Field to sort by
|
|
29202
|
+
in: query
|
|
29145
29203
|
name: sort_by
|
|
29146
29204
|
required: false
|
|
29147
29205
|
schema:
|
|
29148
29206
|
$ref: '#/components/schemas/DomainForwardZoneSortField'
|
|
29149
29207
|
default: created_on
|
|
29150
|
-
|
|
29208
|
+
description: Field to sort by
|
|
29209
|
+
- description: Sort order direction
|
|
29210
|
+
in: query
|
|
29151
29211
|
name: sort_order
|
|
29152
29212
|
required: false
|
|
29153
29213
|
schema:
|
|
29154
29214
|
$ref: '#/components/schemas/SortOrder'
|
|
29155
29215
|
default: desc
|
|
29216
|
+
description: Sort order direction
|
|
29156
29217
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
29157
29218
|
responses:
|
|
29158
29219
|
'200':
|
|
@@ -29255,26 +29316,32 @@ paths:
|
|
|
29255
29316
|
minimum: 1
|
|
29256
29317
|
title: Page Size
|
|
29257
29318
|
type: integer
|
|
29258
|
-
-
|
|
29319
|
+
- description: Search by zone name
|
|
29320
|
+
in: query
|
|
29259
29321
|
name: search
|
|
29260
29322
|
required: false
|
|
29261
29323
|
schema:
|
|
29262
29324
|
anyOf:
|
|
29263
29325
|
- type: string
|
|
29264
29326
|
- type: 'null'
|
|
29327
|
+
description: Search by zone name
|
|
29265
29328
|
title: Search
|
|
29266
|
-
-
|
|
29329
|
+
- description: Field to sort by
|
|
29330
|
+
in: query
|
|
29267
29331
|
name: sort_by
|
|
29268
29332
|
required: false
|
|
29269
29333
|
schema:
|
|
29270
29334
|
$ref: '#/components/schemas/EmailForwardZoneSortField'
|
|
29271
29335
|
default: created_on
|
|
29272
|
-
|
|
29336
|
+
description: Field to sort by
|
|
29337
|
+
- description: Sort order direction
|
|
29338
|
+
in: query
|
|
29273
29339
|
name: sort_order
|
|
29274
29340
|
required: false
|
|
29275
29341
|
schema:
|
|
29276
29342
|
$ref: '#/components/schemas/SortOrder'
|
|
29277
29343
|
default: desc
|
|
29344
|
+
description: Sort order direction
|
|
29278
29345
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
29279
29346
|
responses:
|
|
29280
29347
|
'200':
|
|
@@ -30381,26 +30448,32 @@ paths:
|
|
|
30381
30448
|
minimum: 1
|
|
30382
30449
|
title: Page Size
|
|
30383
30450
|
type: integer
|
|
30384
|
-
-
|
|
30451
|
+
- description: Search by hostname
|
|
30452
|
+
in: query
|
|
30385
30453
|
name: search
|
|
30386
30454
|
required: false
|
|
30387
30455
|
schema:
|
|
30388
30456
|
anyOf:
|
|
30389
30457
|
- type: string
|
|
30390
30458
|
- type: 'null'
|
|
30459
|
+
description: Search by hostname
|
|
30391
30460
|
title: Search
|
|
30392
|
-
-
|
|
30461
|
+
- description: Field to sort by
|
|
30462
|
+
in: query
|
|
30393
30463
|
name: sort_by
|
|
30394
30464
|
required: false
|
|
30395
30465
|
schema:
|
|
30396
30466
|
$ref: '#/components/schemas/DomainForwardSortField'
|
|
30397
30467
|
default: created_on
|
|
30398
|
-
|
|
30468
|
+
description: Field to sort by
|
|
30469
|
+
- description: Sort order direction
|
|
30470
|
+
in: query
|
|
30399
30471
|
name: sort_order
|
|
30400
30472
|
required: false
|
|
30401
30473
|
schema:
|
|
30402
30474
|
$ref: '#/components/schemas/SortOrder'
|
|
30403
30475
|
default: desc
|
|
30476
|
+
description: Sort order direction
|
|
30404
30477
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
30405
30478
|
responses:
|
|
30406
30479
|
'200':
|
|
@@ -33010,18 +33083,22 @@ paths:
|
|
|
33010
33083
|
minimum: 1
|
|
33011
33084
|
title: Page Size
|
|
33012
33085
|
type: integer
|
|
33013
|
-
-
|
|
33086
|
+
- description: Field to sort by
|
|
33087
|
+
in: query
|
|
33014
33088
|
name: sort_by
|
|
33015
33089
|
required: false
|
|
33016
33090
|
schema:
|
|
33017
33091
|
$ref: '#/components/schemas/DomainSortField'
|
|
33018
33092
|
default: created_on
|
|
33019
|
-
|
|
33093
|
+
description: Field to sort by
|
|
33094
|
+
- description: Sort order direction
|
|
33095
|
+
in: query
|
|
33020
33096
|
name: sort_order
|
|
33021
33097
|
required: false
|
|
33022
33098
|
schema:
|
|
33023
33099
|
$ref: '#/components/schemas/SortOrder'
|
|
33024
33100
|
default: desc
|
|
33101
|
+
description: Sort order direction
|
|
33025
33102
|
- description: Filter by status tag types. Can be specified multiple times.
|
|
33026
33103
|
in: query
|
|
33027
33104
|
name: status_tags
|
|
@@ -33034,12 +33111,22 @@ paths:
|
|
|
33034
33111
|
- type: 'null'
|
|
33035
33112
|
description: Filter by status tag types. Can be specified multiple times.
|
|
33036
33113
|
title: Status Tags
|
|
33037
|
-
-
|
|
33114
|
+
- description: 'How to combine status_tags: ''match_any'' returns objects with
|
|
33115
|
+
at least one of the tags, ''match_all'' returns objects with every tag,
|
|
33116
|
+
''match_none'' returns objects with none of the tags, including objects
|
|
33117
|
+
that carry no status tags at all. Has no effect unless one or more status_tags
|
|
33118
|
+
are supplied.'
|
|
33119
|
+
in: query
|
|
33038
33120
|
name: status_tag_mode
|
|
33039
33121
|
required: false
|
|
33040
33122
|
schema:
|
|
33041
33123
|
$ref: '#/components/schemas/TagFilterMode'
|
|
33042
33124
|
default: match_any
|
|
33125
|
+
description: 'How to combine status_tags: ''match_any'' returns objects
|
|
33126
|
+
with at least one of the tags, ''match_all'' returns objects with every
|
|
33127
|
+
tag, ''match_none'' returns objects with none of the tags, including objects
|
|
33128
|
+
that carry no status tags at all. Has no effect unless one or more status_tags
|
|
33129
|
+
are supplied.'
|
|
33043
33130
|
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
33044
33131
|
in: query
|
|
33045
33132
|
name: tag_ids
|
|
@@ -33057,35 +33144,55 @@ paths:
|
|
|
33057
33144
|
- type: 'null'
|
|
33058
33145
|
description: Filter by user tag IDs. Can be specified multiple times.
|
|
33059
33146
|
title: Tag Ids
|
|
33060
|
-
-
|
|
33147
|
+
- description: 'How to combine tag_ids: ''match_any'' returns objects with at
|
|
33148
|
+
least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
|
|
33149
|
+
returns objects with none of the tags, including objects that carry no user
|
|
33150
|
+
tags at all. Has no effect unless one or more tag_ids are supplied; to filter
|
|
33151
|
+
on whether an object has any user tag, use has_tags.'
|
|
33152
|
+
in: query
|
|
33061
33153
|
name: tag_mode
|
|
33062
33154
|
required: false
|
|
33063
33155
|
schema:
|
|
33064
33156
|
$ref: '#/components/schemas/TagFilterMode'
|
|
33065
33157
|
default: match_any
|
|
33066
|
-
|
|
33158
|
+
description: 'How to combine tag_ids: ''match_any'' returns objects with
|
|
33159
|
+
at least one of the tags, ''match_all'' returns objects with every tag,
|
|
33160
|
+
''match_none'' returns objects with none of the tags, including objects
|
|
33161
|
+
that carry no user tags at all. Has no effect unless one or more tag_ids
|
|
33162
|
+
are supplied; to filter on whether an object has any user tag, use has_tags.'
|
|
33163
|
+
- description: true returns only objects that carry at least one user tag, false
|
|
33164
|
+
only objects that carry none. Status tags are not counted. Combines with
|
|
33165
|
+
tag_ids and the other filters.
|
|
33166
|
+
in: query
|
|
33067
33167
|
name: has_tags
|
|
33068
33168
|
required: false
|
|
33069
33169
|
schema:
|
|
33070
33170
|
anyOf:
|
|
33071
33171
|
- type: boolean
|
|
33072
33172
|
- type: 'null'
|
|
33173
|
+
description: true returns only objects that carry at least one user tag,
|
|
33174
|
+
false only objects that carry none. Status tags are not counted. Combines
|
|
33175
|
+
with tag_ids and the other filters.
|
|
33073
33176
|
title: Has Tags
|
|
33074
|
-
-
|
|
33177
|
+
- description: Filter by exact domain name
|
|
33178
|
+
in: query
|
|
33075
33179
|
name: name
|
|
33076
33180
|
required: false
|
|
33077
33181
|
schema:
|
|
33078
33182
|
anyOf:
|
|
33079
33183
|
- type: string
|
|
33080
33184
|
- type: 'null'
|
|
33185
|
+
description: Filter by exact domain name
|
|
33081
33186
|
title: Name
|
|
33082
|
-
-
|
|
33187
|
+
- description: Search domains by name (contains) or domain ID (exact match)
|
|
33188
|
+
in: query
|
|
33083
33189
|
name: search
|
|
33084
33190
|
required: false
|
|
33085
33191
|
schema:
|
|
33086
33192
|
anyOf:
|
|
33087
33193
|
- type: string
|
|
33088
33194
|
- type: 'null'
|
|
33195
|
+
description: Search domains by name (contains) or domain ID (exact match)
|
|
33089
33196
|
title: Search
|
|
33090
33197
|
- description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
|
|
33091
33198
|
multiple times (union of all provided values).
|
|
@@ -33101,47 +33208,70 @@ paths:
|
|
|
33101
33208
|
description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
|
|
33102
33209
|
multiple times (union of all provided values).
|
|
33103
33210
|
title: Tld
|
|
33104
|
-
-
|
|
33211
|
+
- description: Filter by second-level domain
|
|
33212
|
+
in: query
|
|
33105
33213
|
name: sld
|
|
33106
33214
|
required: false
|
|
33107
33215
|
schema:
|
|
33108
33216
|
anyOf:
|
|
33109
33217
|
- type: string
|
|
33110
33218
|
- type: 'null'
|
|
33219
|
+
description: Filter by second-level domain
|
|
33111
33220
|
title: Sld
|
|
33112
|
-
-
|
|
33221
|
+
- description: Filter domains whose nameserver hostnames contain this text,
|
|
33222
|
+
e.g. `cloudflare` or `ns1.example.com`. Matches the nameservers the domain
|
|
33223
|
+
currently delegates to. The text is matched literally, so `%` and `_` are
|
|
33224
|
+
not wildcards; a trailing dot on a single label anchors at a label boundary,
|
|
33225
|
+
so `ns1.` matches `ns1.example.com` but not `ns10.example.com`. Unlike the
|
|
33226
|
+
other filters this one reads the nameservers of every domain in scope, so
|
|
33227
|
+
expect a slower response, the more so the larger the portfolio.
|
|
33228
|
+
in: query
|
|
33113
33229
|
name: nameserver
|
|
33114
33230
|
required: false
|
|
33115
33231
|
schema:
|
|
33116
33232
|
anyOf:
|
|
33117
33233
|
- type: string
|
|
33118
33234
|
- type: 'null'
|
|
33235
|
+
description: Filter domains whose nameserver hostnames contain this text,
|
|
33236
|
+
e.g. `cloudflare` or `ns1.example.com`. Matches the nameservers the domain
|
|
33237
|
+
currently delegates to. The text is matched literally, so `%` and `_`
|
|
33238
|
+
are not wildcards; a trailing dot on a single label anchors at a label
|
|
33239
|
+
boundary, so `ns1.` matches `ns1.example.com` but not `ns10.example.com`.
|
|
33240
|
+
Unlike the other filters this one reads the nameservers of every domain
|
|
33241
|
+
in scope, so expect a slower response, the more so the larger the portfolio.
|
|
33119
33242
|
title: Nameserver
|
|
33120
|
-
-
|
|
33243
|
+
- description: Filter by transfer lock status
|
|
33244
|
+
in: query
|
|
33121
33245
|
name: transfer_lock
|
|
33122
33246
|
required: false
|
|
33123
33247
|
schema:
|
|
33124
33248
|
anyOf:
|
|
33125
33249
|
- type: boolean
|
|
33126
33250
|
- type: 'null'
|
|
33251
|
+
description: Filter by transfer lock status
|
|
33127
33252
|
title: Transfer Lock
|
|
33128
|
-
-
|
|
33253
|
+
- description: Filter by read-only status
|
|
33254
|
+
in: query
|
|
33129
33255
|
name: read_only
|
|
33130
33256
|
required: false
|
|
33131
33257
|
schema:
|
|
33132
33258
|
anyOf:
|
|
33133
33259
|
- type: boolean
|
|
33134
33260
|
- type: 'null'
|
|
33261
|
+
description: Filter by read-only status
|
|
33135
33262
|
title: Read Only
|
|
33136
|
-
-
|
|
33263
|
+
- description: Filter by premium domain status
|
|
33264
|
+
in: query
|
|
33137
33265
|
name: is_premium
|
|
33138
33266
|
required: false
|
|
33139
33267
|
schema:
|
|
33140
33268
|
anyOf:
|
|
33141
33269
|
- type: boolean
|
|
33142
33270
|
- type: 'null'
|
|
33271
|
+
description: Filter by premium domain status
|
|
33143
33272
|
title: Is Premium
|
|
33144
|
-
-
|
|
33273
|
+
- description: Filter domains created after this date
|
|
33274
|
+
in: query
|
|
33145
33275
|
name: created_after
|
|
33146
33276
|
required: false
|
|
33147
33277
|
schema:
|
|
@@ -33149,8 +33279,10 @@ paths:
|
|
|
33149
33279
|
- format: date-time
|
|
33150
33280
|
type: string
|
|
33151
33281
|
- type: 'null'
|
|
33282
|
+
description: Filter domains created after this date
|
|
33152
33283
|
title: Created After
|
|
33153
|
-
-
|
|
33284
|
+
- description: Filter domains created before this date
|
|
33285
|
+
in: query
|
|
33154
33286
|
name: created_before
|
|
33155
33287
|
required: false
|
|
33156
33288
|
schema:
|
|
@@ -33158,8 +33290,10 @@ paths:
|
|
|
33158
33290
|
- format: date-time
|
|
33159
33291
|
type: string
|
|
33160
33292
|
- type: 'null'
|
|
33293
|
+
description: Filter domains created before this date
|
|
33161
33294
|
title: Created Before
|
|
33162
|
-
-
|
|
33295
|
+
- description: Filter domains updated after this date
|
|
33296
|
+
in: query
|
|
33163
33297
|
name: updated_after
|
|
33164
33298
|
required: false
|
|
33165
33299
|
schema:
|
|
@@ -33167,8 +33301,10 @@ paths:
|
|
|
33167
33301
|
- format: date-time
|
|
33168
33302
|
type: string
|
|
33169
33303
|
- type: 'null'
|
|
33304
|
+
description: Filter domains updated after this date
|
|
33170
33305
|
title: Updated After
|
|
33171
|
-
-
|
|
33306
|
+
- description: Filter domains updated before this date
|
|
33307
|
+
in: query
|
|
33172
33308
|
name: updated_before
|
|
33173
33309
|
required: false
|
|
33174
33310
|
schema:
|
|
@@ -33176,8 +33312,10 @@ paths:
|
|
|
33176
33312
|
- format: date-time
|
|
33177
33313
|
type: string
|
|
33178
33314
|
- type: 'null'
|
|
33315
|
+
description: Filter domains updated before this date
|
|
33179
33316
|
title: Updated Before
|
|
33180
|
-
-
|
|
33317
|
+
- description: Filter domains expiring after this date
|
|
33318
|
+
in: query
|
|
33181
33319
|
name: expires_after
|
|
33182
33320
|
required: false
|
|
33183
33321
|
schema:
|
|
@@ -33185,8 +33323,10 @@ paths:
|
|
|
33185
33323
|
- format: date-time
|
|
33186
33324
|
type: string
|
|
33187
33325
|
- type: 'null'
|
|
33326
|
+
description: Filter domains expiring after this date
|
|
33188
33327
|
title: Expires After
|
|
33189
|
-
-
|
|
33328
|
+
- description: Filter domains expiring before this date
|
|
33329
|
+
in: query
|
|
33190
33330
|
name: expires_before
|
|
33191
33331
|
required: false
|
|
33192
33332
|
schema:
|
|
@@ -33194,32 +33334,40 @@ paths:
|
|
|
33194
33334
|
- format: date-time
|
|
33195
33335
|
type: string
|
|
33196
33336
|
- type: 'null'
|
|
33337
|
+
description: Filter domains expiring before this date
|
|
33197
33338
|
title: Expires Before
|
|
33198
|
-
-
|
|
33339
|
+
- description: Filter domains expiring within the next 30 days
|
|
33340
|
+
in: query
|
|
33199
33341
|
name: expires_in_30_days
|
|
33200
33342
|
required: false
|
|
33201
33343
|
schema:
|
|
33202
33344
|
anyOf:
|
|
33203
33345
|
- type: boolean
|
|
33204
33346
|
- type: 'null'
|
|
33347
|
+
description: Filter domains expiring within the next 30 days
|
|
33205
33348
|
title: Expires In 30 Days
|
|
33206
|
-
-
|
|
33349
|
+
- description: Filter domains expiring within the next 60 days
|
|
33350
|
+
in: query
|
|
33207
33351
|
name: expires_in_60_days
|
|
33208
33352
|
required: false
|
|
33209
33353
|
schema:
|
|
33210
33354
|
anyOf:
|
|
33211
33355
|
- type: boolean
|
|
33212
33356
|
- type: 'null'
|
|
33357
|
+
description: Filter domains expiring within the next 60 days
|
|
33213
33358
|
title: Expires In 60 Days
|
|
33214
|
-
-
|
|
33359
|
+
- description: Filter domains expiring within the next 90 days
|
|
33360
|
+
in: query
|
|
33215
33361
|
name: expires_in_90_days
|
|
33216
33362
|
required: false
|
|
33217
33363
|
schema:
|
|
33218
33364
|
anyOf:
|
|
33219
33365
|
- type: boolean
|
|
33220
33366
|
- type: 'null'
|
|
33367
|
+
description: Filter domains expiring within the next 90 days
|
|
33221
33368
|
title: Expires In 90 Days
|
|
33222
|
-
-
|
|
33369
|
+
- description: Filter domains registered after this date
|
|
33370
|
+
in: query
|
|
33223
33371
|
name: registered_after
|
|
33224
33372
|
required: false
|
|
33225
33373
|
schema:
|
|
@@ -33227,8 +33375,10 @@ paths:
|
|
|
33227
33375
|
- format: date-time
|
|
33228
33376
|
type: string
|
|
33229
33377
|
- type: 'null'
|
|
33378
|
+
description: Filter domains registered after this date
|
|
33230
33379
|
title: Registered After
|
|
33231
|
-
-
|
|
33380
|
+
- description: Filter domains registered before this date
|
|
33381
|
+
in: query
|
|
33232
33382
|
name: registered_before
|
|
33233
33383
|
required: false
|
|
33234
33384
|
schema:
|
|
@@ -33236,8 +33386,10 @@ paths:
|
|
|
33236
33386
|
- format: date-time
|
|
33237
33387
|
type: string
|
|
33238
33388
|
- type: 'null'
|
|
33389
|
+
description: Filter domains registered before this date
|
|
33239
33390
|
title: Registered Before
|
|
33240
|
-
-
|
|
33391
|
+
- description: Filter domains transferred in after this date
|
|
33392
|
+
in: query
|
|
33241
33393
|
name: transferred_after
|
|
33242
33394
|
required: false
|
|
33243
33395
|
schema:
|
|
@@ -33245,8 +33397,10 @@ paths:
|
|
|
33245
33397
|
- format: date-time
|
|
33246
33398
|
type: string
|
|
33247
33399
|
- type: 'null'
|
|
33400
|
+
description: Filter domains transferred in after this date
|
|
33248
33401
|
title: Transferred After
|
|
33249
|
-
-
|
|
33402
|
+
- description: Filter domains transferred in before this date
|
|
33403
|
+
in: query
|
|
33250
33404
|
name: transferred_before
|
|
33251
33405
|
required: false
|
|
33252
33406
|
schema:
|
|
@@ -33254,6 +33408,7 @@ paths:
|
|
|
33254
33408
|
- format: date-time
|
|
33255
33409
|
type: string
|
|
33256
33410
|
- type: 'null'
|
|
33411
|
+
description: Filter domains transferred in before this date
|
|
33257
33412
|
title: Transferred Before
|
|
33258
33413
|
- description: Filter domains by registry status. Can be specified multiple
|
|
33259
33414
|
times (union of all provided values).
|
|
@@ -33663,54 +33818,80 @@ paths:
|
|
|
33663
33818
|
zero.'
|
|
33664
33819
|
operationId: get_domain_statistics_v1_domains_statistics_get
|
|
33665
33820
|
parameters:
|
|
33666
|
-
-
|
|
33821
|
+
- description: First day of the window, inclusive (YYYY-MM-DD, UTC)
|
|
33822
|
+
in: query
|
|
33667
33823
|
name: start_date
|
|
33668
33824
|
required: true
|
|
33669
33825
|
schema:
|
|
33826
|
+
description: First day of the window, inclusive (YYYY-MM-DD, UTC)
|
|
33670
33827
|
format: date
|
|
33671
33828
|
title: Start Date
|
|
33672
33829
|
type: string
|
|
33673
|
-
-
|
|
33830
|
+
- description: 'Last day of the window, inclusive (YYYY-MM-DD, UTC). How far
|
|
33831
|
+
it may reach depends on `granularity`: at most 92 days for `day`, 371 days
|
|
33832
|
+
for `week`, 396 days for `month`.'
|
|
33833
|
+
in: query
|
|
33674
33834
|
name: end_date
|
|
33675
33835
|
required: true
|
|
33676
33836
|
schema:
|
|
33837
|
+
description: 'Last day of the window, inclusive (YYYY-MM-DD, UTC). How far
|
|
33838
|
+
it may reach depends on `granularity`: at most 92 days for `day`, 371
|
|
33839
|
+
days for `week`, 396 days for `month`.'
|
|
33677
33840
|
format: date
|
|
33678
33841
|
title: End Date
|
|
33679
33842
|
type: string
|
|
33680
|
-
-
|
|
33843
|
+
- description: Time-bucket size. Weeks start on Monday and months on the 1st,
|
|
33844
|
+
in UTC.
|
|
33845
|
+
in: query
|
|
33681
33846
|
name: granularity
|
|
33682
33847
|
required: false
|
|
33683
33848
|
schema:
|
|
33684
33849
|
$ref: '#/components/schemas/UsageGranularity'
|
|
33685
33850
|
default: day
|
|
33686
|
-
|
|
33851
|
+
description: Time-bucket size. Weeks start on Monday and months on the 1st,
|
|
33852
|
+
in UTC.
|
|
33853
|
+
- description: Restrict the counts to one top-level domain, e.g. `com`.
|
|
33854
|
+
in: query
|
|
33687
33855
|
name: tld
|
|
33688
33856
|
required: false
|
|
33689
33857
|
schema:
|
|
33690
33858
|
anyOf:
|
|
33691
33859
|
- type: string
|
|
33692
33860
|
- type: 'null'
|
|
33861
|
+
description: Restrict the counts to one top-level domain, e.g. `com`.
|
|
33693
33862
|
title: Tld
|
|
33694
|
-
-
|
|
33863
|
+
- description: 'Adds a top-N list to the response: `organization` ranks your
|
|
33864
|
+
organization and its sub-organizations (so it needs `include_sub_organizations=true`),
|
|
33865
|
+
`tld` ranks the top-level domains.'
|
|
33866
|
+
in: query
|
|
33695
33867
|
name: breakdown
|
|
33696
33868
|
required: false
|
|
33697
33869
|
schema:
|
|
33698
33870
|
$ref: '#/components/schemas/DomainStatisticsBreakdown'
|
|
33699
33871
|
default: none
|
|
33700
|
-
|
|
33872
|
+
description: 'Adds a top-N list to the response: `organization` ranks your
|
|
33873
|
+
organization and its sub-organizations (so it needs `include_sub_organizations=true`),
|
|
33874
|
+
`tld` ranks the top-level domains.'
|
|
33875
|
+
- description: How many rows the breakdown lists.
|
|
33876
|
+
in: query
|
|
33701
33877
|
name: breakdown_limit
|
|
33702
33878
|
required: false
|
|
33703
33879
|
schema:
|
|
33704
33880
|
default: 10
|
|
33881
|
+
description: How many rows the breakdown lists.
|
|
33705
33882
|
maximum: 50
|
|
33706
33883
|
minimum: 1
|
|
33707
33884
|
title: Breakdown Limit
|
|
33708
33885
|
type: integer
|
|
33709
|
-
-
|
|
33886
|
+
- description: Count your sub-organizations' domains too. By default only your
|
|
33887
|
+
own organization's domains are counted, as in the domain summary.
|
|
33888
|
+
in: query
|
|
33710
33889
|
name: include_sub_organizations
|
|
33711
33890
|
required: false
|
|
33712
33891
|
schema:
|
|
33713
33892
|
default: false
|
|
33893
|
+
description: Count your sub-organizations' domains too. By default only
|
|
33894
|
+
your own organization's domains are counted, as in the domain summary.
|
|
33714
33895
|
title: Include Sub Organizations
|
|
33715
33896
|
type: boolean
|
|
33716
33897
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
@@ -35740,34 +35921,42 @@ paths:
|
|
|
35740
35921
|
minimum: 1
|
|
35741
35922
|
title: Page Size
|
|
35742
35923
|
type: integer
|
|
35743
|
-
-
|
|
35924
|
+
- description: Search by hostname
|
|
35925
|
+
in: query
|
|
35744
35926
|
name: search
|
|
35745
35927
|
required: false
|
|
35746
35928
|
schema:
|
|
35747
35929
|
anyOf:
|
|
35748
35930
|
- type: string
|
|
35749
35931
|
- type: 'null'
|
|
35932
|
+
description: Search by hostname
|
|
35750
35933
|
title: Search
|
|
35751
|
-
-
|
|
35934
|
+
- description: Filter by enabled status
|
|
35935
|
+
in: query
|
|
35752
35936
|
name: enabled
|
|
35753
35937
|
required: false
|
|
35754
35938
|
schema:
|
|
35755
35939
|
anyOf:
|
|
35756
35940
|
- type: boolean
|
|
35757
35941
|
- type: 'null'
|
|
35942
|
+
description: Filter by enabled status
|
|
35758
35943
|
title: Enabled
|
|
35759
|
-
-
|
|
35944
|
+
- description: Field to sort by
|
|
35945
|
+
in: query
|
|
35760
35946
|
name: sort_by
|
|
35761
35947
|
required: false
|
|
35762
35948
|
schema:
|
|
35763
35949
|
$ref: '#/components/schemas/EmailForwardSortField'
|
|
35764
35950
|
default: created_on
|
|
35765
|
-
|
|
35951
|
+
description: Field to sort by
|
|
35952
|
+
- description: Sort order direction
|
|
35953
|
+
in: query
|
|
35766
35954
|
name: sort_order
|
|
35767
35955
|
required: false
|
|
35768
35956
|
schema:
|
|
35769
35957
|
$ref: '#/components/schemas/SortOrder'
|
|
35770
35958
|
default: desc
|
|
35959
|
+
description: Sort order direction
|
|
35771
35960
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
35772
35961
|
responses:
|
|
35773
35962
|
'200':
|
|
@@ -36632,7 +36821,8 @@ paths:
|
|
|
36632
36821
|
title: Email Forward Id
|
|
36633
36822
|
type: string
|
|
36634
36823
|
x-typeid-prefix: email_forward
|
|
36635
|
-
-
|
|
36824
|
+
- description: Filter metrics after (RFC3339)
|
|
36825
|
+
in: query
|
|
36636
36826
|
name: start_time
|
|
36637
36827
|
required: false
|
|
36638
36828
|
schema:
|
|
@@ -36640,8 +36830,10 @@ paths:
|
|
|
36640
36830
|
- format: date-time
|
|
36641
36831
|
type: string
|
|
36642
36832
|
- type: 'null'
|
|
36833
|
+
description: Filter metrics after (RFC3339)
|
|
36643
36834
|
title: Start Time
|
|
36644
|
-
-
|
|
36835
|
+
- description: Filter metrics before (RFC3339)
|
|
36836
|
+
in: query
|
|
36645
36837
|
name: end_time
|
|
36646
36838
|
required: false
|
|
36647
36839
|
schema:
|
|
@@ -36649,6 +36841,7 @@ paths:
|
|
|
36649
36841
|
- format: date-time
|
|
36650
36842
|
type: string
|
|
36651
36843
|
- type: 'null'
|
|
36844
|
+
description: Filter metrics before (RFC3339)
|
|
36652
36845
|
title: End Time
|
|
36653
36846
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
36654
36847
|
responses:
|
|
@@ -36730,51 +36923,64 @@ paths:
|
|
|
36730
36923
|
minimum: 1
|
|
36731
36924
|
title: Page Size
|
|
36732
36925
|
type: integer
|
|
36733
|
-
-
|
|
36926
|
+
- description: Field to sort by
|
|
36927
|
+
in: query
|
|
36734
36928
|
name: sort_by
|
|
36735
36929
|
required: false
|
|
36736
36930
|
schema:
|
|
36737
36931
|
$ref: '#/components/schemas/EventSortField'
|
|
36738
36932
|
default: created_on
|
|
36739
|
-
|
|
36933
|
+
description: Field to sort by
|
|
36934
|
+
- description: Sort order direction
|
|
36935
|
+
in: query
|
|
36740
36936
|
name: sort_order
|
|
36741
36937
|
required: false
|
|
36742
36938
|
schema:
|
|
36743
36939
|
$ref: '#/components/schemas/SortOrder'
|
|
36744
36940
|
default: desc
|
|
36745
|
-
|
|
36941
|
+
description: Sort order direction
|
|
36942
|
+
- description: Filter by
|
|
36943
|
+
in: query
|
|
36746
36944
|
name: object_type
|
|
36747
36945
|
required: false
|
|
36748
36946
|
schema:
|
|
36749
36947
|
anyOf:
|
|
36750
36948
|
- $ref: '#/components/schemas/EventObjectType'
|
|
36751
36949
|
- type: 'null'
|
|
36950
|
+
description: Filter by
|
|
36752
36951
|
title: Object Type
|
|
36753
|
-
-
|
|
36952
|
+
- description: Filter by specific domain/contact/host name
|
|
36953
|
+
in: query
|
|
36754
36954
|
name: object_id
|
|
36755
36955
|
required: false
|
|
36756
36956
|
schema:
|
|
36757
36957
|
anyOf:
|
|
36758
36958
|
- type: string
|
|
36759
36959
|
- type: 'null'
|
|
36960
|
+
description: Filter by specific domain/contact/host name
|
|
36760
36961
|
title: Object Id
|
|
36761
|
-
-
|
|
36962
|
+
- description: Filter by event type
|
|
36963
|
+
in: query
|
|
36762
36964
|
name: type
|
|
36763
36965
|
required: false
|
|
36764
36966
|
schema:
|
|
36765
36967
|
anyOf:
|
|
36766
36968
|
- $ref: '#/components/schemas/EventType'
|
|
36767
36969
|
- type: 'null'
|
|
36970
|
+
description: Filter by event type
|
|
36768
36971
|
title: Type
|
|
36769
|
-
-
|
|
36972
|
+
- description: Filter by subtype
|
|
36973
|
+
in: query
|
|
36770
36974
|
name: subtype
|
|
36771
36975
|
required: false
|
|
36772
36976
|
schema:
|
|
36773
36977
|
anyOf:
|
|
36774
36978
|
- $ref: '#/components/schemas/EventSubtype'
|
|
36775
36979
|
- type: 'null'
|
|
36980
|
+
description: Filter by subtype
|
|
36776
36981
|
title: Subtype
|
|
36777
|
-
-
|
|
36982
|
+
- description: Filter by acknowledgment status
|
|
36983
|
+
in: query
|
|
36778
36984
|
name: acknowledged
|
|
36779
36985
|
required: false
|
|
36780
36986
|
schema:
|
|
@@ -36782,6 +36988,7 @@ paths:
|
|
|
36782
36988
|
- type: boolean
|
|
36783
36989
|
- type: 'null'
|
|
36784
36990
|
default: false
|
|
36991
|
+
description: Filter by acknowledgment status
|
|
36785
36992
|
title: Acknowledged
|
|
36786
36993
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
36787
36994
|
responses:
|
|
@@ -38776,19 +38983,24 @@ paths:
|
|
|
38776
38983
|
minimum: 1
|
|
38777
38984
|
title: Page Size
|
|
38778
38985
|
type: integer
|
|
38779
|
-
-
|
|
38986
|
+
- description: Field to sort by
|
|
38987
|
+
in: query
|
|
38780
38988
|
name: sort_by
|
|
38781
38989
|
required: false
|
|
38782
38990
|
schema:
|
|
38783
38991
|
$ref: '#/components/schemas/OrganizationSortField'
|
|
38784
38992
|
default: created_on
|
|
38785
|
-
|
|
38993
|
+
description: Field to sort by
|
|
38994
|
+
- description: Sort order direction
|
|
38995
|
+
in: query
|
|
38786
38996
|
name: sort_order
|
|
38787
38997
|
required: false
|
|
38788
38998
|
schema:
|
|
38789
38999
|
$ref: '#/components/schemas/SortOrder'
|
|
38790
39000
|
default: desc
|
|
38791
|
-
|
|
39001
|
+
description: Sort order direction
|
|
39002
|
+
- description: Search across organization name, address, and city
|
|
39003
|
+
in: query
|
|
38792
39004
|
name: search
|
|
38793
39005
|
required: false
|
|
38794
39006
|
schema:
|
|
@@ -38796,8 +39008,10 @@ paths:
|
|
|
38796
39008
|
- maxLength: 200
|
|
38797
39009
|
type: string
|
|
38798
39010
|
- type: 'null'
|
|
39011
|
+
description: Search across organization name, address, and city
|
|
38799
39012
|
title: Search
|
|
38800
|
-
-
|
|
39013
|
+
- description: Filter by country code
|
|
39014
|
+
in: query
|
|
38801
39015
|
name: country_code
|
|
38802
39016
|
required: false
|
|
38803
39017
|
schema:
|
|
@@ -38805,6 +39019,7 @@ paths:
|
|
|
38805
39019
|
- pattern: ^\w{2}$
|
|
38806
39020
|
type: string
|
|
38807
39021
|
- type: 'null'
|
|
39022
|
+
description: Filter by country code
|
|
38808
39023
|
title: Country Code
|
|
38809
39024
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
38810
39025
|
responses:
|
|
@@ -39943,19 +40158,24 @@ paths:
|
|
|
39943
40158
|
minimum: 1
|
|
39944
40159
|
title: Page Size
|
|
39945
40160
|
type: integer
|
|
39946
|
-
-
|
|
40161
|
+
- description: Field to sort by
|
|
40162
|
+
in: query
|
|
39947
40163
|
name: sort_by
|
|
39948
40164
|
required: false
|
|
39949
40165
|
schema:
|
|
39950
40166
|
$ref: '#/components/schemas/UserSortField'
|
|
39951
40167
|
default: created_on
|
|
39952
|
-
|
|
40168
|
+
description: Field to sort by
|
|
40169
|
+
- description: Sort order direction
|
|
40170
|
+
in: query
|
|
39953
40171
|
name: sort_order
|
|
39954
40172
|
required: false
|
|
39955
40173
|
schema:
|
|
39956
40174
|
$ref: '#/components/schemas/SortOrder'
|
|
39957
40175
|
default: desc
|
|
39958
|
-
|
|
40176
|
+
description: Sort order direction
|
|
40177
|
+
- description: Search across username, email, first name, and last name
|
|
40178
|
+
in: query
|
|
39959
40179
|
name: search
|
|
39960
40180
|
required: false
|
|
39961
40181
|
schema:
|
|
@@ -39963,6 +40183,7 @@ paths:
|
|
|
39963
40183
|
- maxLength: 200
|
|
39964
40184
|
type: string
|
|
39965
40185
|
- type: 'null'
|
|
40186
|
+
description: Search across username, email, first name, and last name
|
|
39966
40187
|
title: Search
|
|
39967
40188
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
39968
40189
|
responses:
|
|
@@ -40579,19 +40800,24 @@ paths:
|
|
|
40579
40800
|
minimum: 1
|
|
40580
40801
|
title: Page Size
|
|
40581
40802
|
type: integer
|
|
40582
|
-
-
|
|
40803
|
+
- description: Field to sort by
|
|
40804
|
+
in: query
|
|
40583
40805
|
name: sort_by
|
|
40584
40806
|
required: false
|
|
40585
40807
|
schema:
|
|
40586
40808
|
$ref: '#/components/schemas/BillingTransactionSortField'
|
|
40587
40809
|
default: created_on
|
|
40588
|
-
|
|
40810
|
+
description: Field to sort by
|
|
40811
|
+
- description: Sort order direction
|
|
40812
|
+
in: query
|
|
40589
40813
|
name: sort_order
|
|
40590
40814
|
required: false
|
|
40591
40815
|
schema:
|
|
40592
40816
|
$ref: '#/components/schemas/SortOrder'
|
|
40593
40817
|
default: desc
|
|
40594
|
-
|
|
40818
|
+
description: Sort order direction
|
|
40819
|
+
- description: Filter by product reference
|
|
40820
|
+
in: query
|
|
40595
40821
|
name: product_reference
|
|
40596
40822
|
required: false
|
|
40597
40823
|
schema:
|
|
@@ -40600,32 +40826,40 @@ paths:
|
|
|
40600
40826
|
minLength: 1
|
|
40601
40827
|
type: string
|
|
40602
40828
|
- type: 'null'
|
|
40829
|
+
description: Filter by product reference
|
|
40603
40830
|
title: Product Reference
|
|
40604
|
-
-
|
|
40831
|
+
- description: Filter by product type
|
|
40832
|
+
in: query
|
|
40605
40833
|
name: product_type
|
|
40606
40834
|
required: false
|
|
40607
40835
|
schema:
|
|
40608
40836
|
anyOf:
|
|
40609
40837
|
- $ref: '#/components/schemas/BillingTransactionProductType'
|
|
40610
40838
|
- type: 'null'
|
|
40839
|
+
description: Filter by product type
|
|
40611
40840
|
title: Product Type
|
|
40612
|
-
-
|
|
40841
|
+
- description: Filter by action
|
|
40842
|
+
in: query
|
|
40613
40843
|
name: action
|
|
40614
40844
|
required: false
|
|
40615
40845
|
schema:
|
|
40616
40846
|
anyOf:
|
|
40617
40847
|
- $ref: '#/components/schemas/BillingTransactionAction'
|
|
40618
40848
|
- type: 'null'
|
|
40849
|
+
description: Filter by action
|
|
40619
40850
|
title: Action
|
|
40620
|
-
-
|
|
40851
|
+
- description: Filter by status
|
|
40852
|
+
in: query
|
|
40621
40853
|
name: status
|
|
40622
40854
|
required: false
|
|
40623
40855
|
schema:
|
|
40624
40856
|
anyOf:
|
|
40625
40857
|
- $ref: '#/components/schemas/BillingTransactionStatus'
|
|
40626
40858
|
- type: 'null'
|
|
40859
|
+
description: Filter by status
|
|
40627
40860
|
title: Status
|
|
40628
|
-
-
|
|
40861
|
+
- description: Filter by transactions created after this date
|
|
40862
|
+
in: query
|
|
40629
40863
|
name: created_after
|
|
40630
40864
|
required: false
|
|
40631
40865
|
schema:
|
|
@@ -40633,8 +40867,10 @@ paths:
|
|
|
40633
40867
|
- format: date-time
|
|
40634
40868
|
type: string
|
|
40635
40869
|
- type: 'null'
|
|
40870
|
+
description: Filter by transactions created after this date
|
|
40636
40871
|
title: Created After
|
|
40637
|
-
-
|
|
40872
|
+
- description: Filter by transactions created before this date
|
|
40873
|
+
in: query
|
|
40638
40874
|
name: created_before
|
|
40639
40875
|
required: false
|
|
40640
40876
|
schema:
|
|
@@ -40642,8 +40878,10 @@ paths:
|
|
|
40642
40878
|
- format: date-time
|
|
40643
40879
|
type: string
|
|
40644
40880
|
- type: 'null'
|
|
40881
|
+
description: Filter by transactions created before this date
|
|
40645
40882
|
title: Created Before
|
|
40646
|
-
-
|
|
40883
|
+
- description: Filter by transactions completed after this date
|
|
40884
|
+
in: query
|
|
40647
40885
|
name: completed_after
|
|
40648
40886
|
required: false
|
|
40649
40887
|
schema:
|
|
@@ -40651,8 +40889,10 @@ paths:
|
|
|
40651
40889
|
- format: date-time
|
|
40652
40890
|
type: string
|
|
40653
40891
|
- type: 'null'
|
|
40892
|
+
description: Filter by transactions completed after this date
|
|
40654
40893
|
title: Completed After
|
|
40655
|
-
-
|
|
40894
|
+
- description: Filter by transactions completed before this date
|
|
40895
|
+
in: query
|
|
40656
40896
|
name: completed_before
|
|
40657
40897
|
required: false
|
|
40658
40898
|
schema:
|
|
@@ -40660,6 +40900,7 @@ paths:
|
|
|
40660
40900
|
- format: date-time
|
|
40661
40901
|
type: string
|
|
40662
40902
|
- type: 'null'
|
|
40903
|
+
description: Filter by transactions completed before this date
|
|
40663
40904
|
title: Completed Before
|
|
40664
40905
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
40665
40906
|
responses:
|
|
@@ -40989,41 +41230,51 @@ paths:
|
|
|
40989
41230
|
minimum: 1
|
|
40990
41231
|
title: Page Size
|
|
40991
41232
|
type: integer
|
|
40992
|
-
-
|
|
41233
|
+
- description: Field to sort by
|
|
41234
|
+
in: query
|
|
40993
41235
|
name: sort_by
|
|
40994
41236
|
required: false
|
|
40995
41237
|
schema:
|
|
40996
41238
|
$ref: '#/components/schemas/ParkingSortField'
|
|
40997
41239
|
default: created_on
|
|
40998
|
-
|
|
41240
|
+
description: Field to sort by
|
|
41241
|
+
- description: Sort order direction
|
|
41242
|
+
in: query
|
|
40999
41243
|
name: sort_order
|
|
41000
41244
|
required: false
|
|
41001
41245
|
schema:
|
|
41002
41246
|
$ref: '#/components/schemas/SortOrder'
|
|
41003
41247
|
default: desc
|
|
41004
|
-
|
|
41248
|
+
description: Sort order direction
|
|
41249
|
+
- description: Search parking entries by domain name (contains)
|
|
41250
|
+
in: query
|
|
41005
41251
|
name: search
|
|
41006
41252
|
required: false
|
|
41007
41253
|
schema:
|
|
41008
41254
|
anyOf:
|
|
41009
41255
|
- type: string
|
|
41010
41256
|
- type: 'null'
|
|
41257
|
+
description: Search parking entries by domain name (contains)
|
|
41011
41258
|
title: Search
|
|
41012
|
-
-
|
|
41259
|
+
- description: Filter by enabled status
|
|
41260
|
+
in: query
|
|
41013
41261
|
name: enabled
|
|
41014
41262
|
required: false
|
|
41015
41263
|
schema:
|
|
41016
41264
|
anyOf:
|
|
41017
41265
|
- type: boolean
|
|
41018
41266
|
- type: 'null'
|
|
41267
|
+
description: Filter by enabled status
|
|
41019
41268
|
title: Enabled
|
|
41020
|
-
-
|
|
41269
|
+
- description: Filter by compliance status
|
|
41270
|
+
in: query
|
|
41021
41271
|
name: compliance_status
|
|
41022
41272
|
required: false
|
|
41023
41273
|
schema:
|
|
41024
41274
|
anyOf:
|
|
41025
41275
|
- $ref: '#/components/schemas/ComplianceStatus'
|
|
41026
41276
|
- type: 'null'
|
|
41277
|
+
description: Filter by compliance status
|
|
41027
41278
|
title: Compliance Status
|
|
41028
41279
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
41029
41280
|
responses:
|
|
@@ -41076,7 +41327,8 @@ paths:
|
|
|
41076
41327
|
description: Retrieves aggregated metrics for all parking entries of the organization.
|
|
41077
41328
|
operationId: get_total_parking_metrics_v1_parking_metrics_get
|
|
41078
41329
|
parameters:
|
|
41079
|
-
-
|
|
41330
|
+
- description: Filter metrics after (RFC3339)
|
|
41331
|
+
in: query
|
|
41080
41332
|
name: start_time
|
|
41081
41333
|
required: false
|
|
41082
41334
|
schema:
|
|
@@ -41084,8 +41336,10 @@ paths:
|
|
|
41084
41336
|
- format: date-time
|
|
41085
41337
|
type: string
|
|
41086
41338
|
- type: 'null'
|
|
41339
|
+
description: Filter metrics after (RFC3339)
|
|
41087
41340
|
title: Start Time
|
|
41088
|
-
-
|
|
41341
|
+
- description: Filter metrics before (RFC3339)
|
|
41342
|
+
in: query
|
|
41089
41343
|
name: end_time
|
|
41090
41344
|
required: false
|
|
41091
41345
|
schema:
|
|
@@ -41093,6 +41347,7 @@ paths:
|
|
|
41093
41347
|
- format: date-time
|
|
41094
41348
|
type: string
|
|
41095
41349
|
- type: 'null'
|
|
41350
|
+
description: Filter metrics before (RFC3339)
|
|
41096
41351
|
title: End Time
|
|
41097
41352
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
41098
41353
|
responses:
|
|
@@ -41267,7 +41522,8 @@ paths:
|
|
|
41267
41522
|
x-typeid-prefix: parking
|
|
41268
41523
|
- type: string
|
|
41269
41524
|
title: Parking Reference
|
|
41270
|
-
-
|
|
41525
|
+
- description: Filter metrics after (RFC3339)
|
|
41526
|
+
in: query
|
|
41271
41527
|
name: start_time
|
|
41272
41528
|
required: false
|
|
41273
41529
|
schema:
|
|
@@ -41275,8 +41531,10 @@ paths:
|
|
|
41275
41531
|
- format: date-time
|
|
41276
41532
|
type: string
|
|
41277
41533
|
- type: 'null'
|
|
41534
|
+
description: Filter metrics after (RFC3339)
|
|
41278
41535
|
title: Start Time
|
|
41279
|
-
-
|
|
41536
|
+
- description: Filter metrics before (RFC3339)
|
|
41537
|
+
in: query
|
|
41280
41538
|
name: end_time
|
|
41281
41539
|
required: false
|
|
41282
41540
|
schema:
|
|
@@ -41284,6 +41542,7 @@ paths:
|
|
|
41284
41542
|
- format: date-time
|
|
41285
41543
|
type: string
|
|
41286
41544
|
- type: 'null'
|
|
41545
|
+
description: Filter metrics before (RFC3339)
|
|
41287
41546
|
title: End Time
|
|
41288
41547
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
41289
41548
|
responses:
|
|
@@ -41549,18 +41808,22 @@ paths:
|
|
|
41549
41808
|
minimum: 1
|
|
41550
41809
|
title: Page Size
|
|
41551
41810
|
type: integer
|
|
41552
|
-
-
|
|
41811
|
+
- description: Field to sort by
|
|
41812
|
+
in: query
|
|
41553
41813
|
name: sort_by
|
|
41554
41814
|
required: false
|
|
41555
41815
|
schema:
|
|
41556
41816
|
$ref: '#/components/schemas/TagSortField'
|
|
41557
41817
|
default: label
|
|
41558
|
-
|
|
41818
|
+
description: Field to sort by
|
|
41819
|
+
- description: Sort order direction
|
|
41820
|
+
in: query
|
|
41559
41821
|
name: sort_order
|
|
41560
41822
|
required: false
|
|
41561
41823
|
schema:
|
|
41562
41824
|
$ref: '#/components/schemas/SortOrder'
|
|
41563
41825
|
default: asc
|
|
41826
|
+
description: Sort order direction
|
|
41564
41827
|
- description: Filter by tag types (OR semantics)
|
|
41565
41828
|
in: query
|
|
41566
41829
|
name: tag_types
|
|
@@ -41573,13 +41836,15 @@ paths:
|
|
|
41573
41836
|
- type: 'null'
|
|
41574
41837
|
description: Filter by tag types (OR semantics)
|
|
41575
41838
|
title: Tag Types
|
|
41576
|
-
-
|
|
41839
|
+
- description: Search tags by label (contains)
|
|
41840
|
+
in: query
|
|
41577
41841
|
name: search
|
|
41578
41842
|
required: false
|
|
41579
41843
|
schema:
|
|
41580
41844
|
anyOf:
|
|
41581
41845
|
- type: string
|
|
41582
41846
|
- type: 'null'
|
|
41847
|
+
description: Search tags by label (contains)
|
|
41583
41848
|
title: Search
|
|
41584
41849
|
- $ref: '#/components/parameters/DatetimeFormatHeader'
|
|
41585
41850
|
responses:
|