@opusdns/api 1.208.0 → 1.209.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/src/openapi.yaml CHANGED
@@ -25000,7 +25000,7 @@ info:
25000
25000
  \n\n"
25001
25001
  summary: OpusDNS - your gateway to a seamless domain management experience.
25002
25002
  title: OpusDNS API
25003
- version: 2026-10-01-130224
25003
+ version: 2026-10-01-204618
25004
25004
  x-logo:
25005
25005
  altText: OpusDNS API Reference
25006
25006
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -26316,44 +26316,59 @@ paths:
26316
26316
  title: Email Forward Id
26317
26317
  type: string
26318
26318
  x-typeid-prefix: email_forward
26319
- - in: query
26319
+ - description: Sort field (log_id, domain, sender_email, recipient_email, forward_email,
26320
+ final_status, created_on, synced_on)
26321
+ in: query
26320
26322
  name: sort_by
26321
26323
  required: false
26322
26324
  schema:
26323
26325
  $ref: '#/components/schemas/EmailForwardLogSortField'
26324
26326
  default: created_on
26325
- - in: query
26327
+ description: Sort field (log_id, domain, sender_email, recipient_email,
26328
+ forward_email, final_status, created_on, synced_on)
26329
+ - description: Sort order (asc, desc)
26330
+ in: query
26326
26331
  name: sort_order
26327
26332
  required: false
26328
26333
  schema:
26329
26334
  $ref: '#/components/schemas/SortOrder'
26330
26335
  default: desc
26331
- - in: query
26336
+ description: Sort order (asc, desc)
26337
+ - description: Records per page
26338
+ in: query
26332
26339
  name: page_size
26333
26340
  required: false
26334
26341
  schema:
26335
26342
  default: 50
26343
+ description: Records per page
26336
26344
  maximum: 1000
26337
26345
  minimum: 1
26338
26346
  title: Page Size
26339
26347
  type: integer
26340
- - in: query
26348
+ - description: Page number
26349
+ in: query
26341
26350
  name: page
26342
26351
  required: false
26343
26352
  schema:
26344
26353
  default: 1
26354
+ description: Page number
26345
26355
  minimum: 1
26346
26356
  title: Page
26347
26357
  type: integer
26348
- - in: query
26358
+ - description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26359
+ HARD-BOUNCE)
26360
+ in: query
26349
26361
  name: final_status
26350
26362
  required: false
26351
26363
  schema:
26352
26364
  anyOf:
26353
26365
  - $ref: '#/components/schemas/EmailForwardLogStatus'
26354
26366
  - type: 'null'
26367
+ description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26368
+ HARD-BOUNCE)
26355
26369
  title: Final Status
26356
- - in: query
26370
+ - description: Filter logs after (RFC3339)
26371
+ in: query
26357
26372
  name: start_time
26358
26373
  required: false
26359
26374
  schema:
@@ -26361,8 +26376,10 @@ paths:
26361
26376
  - format: date-time
26362
26377
  type: string
26363
26378
  - type: 'null'
26379
+ description: Filter logs after (RFC3339)
26364
26380
  title: Start Time
26365
- - in: query
26381
+ - description: Filter logs before (RFC3339)
26382
+ in: query
26366
26383
  name: end_time
26367
26384
  required: false
26368
26385
  schema:
@@ -26370,6 +26387,7 @@ paths:
26370
26387
  - format: date-time
26371
26388
  type: string
26372
26389
  - type: 'null'
26390
+ description: Filter logs before (RFC3339)
26373
26391
  title: End Time
26374
26392
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26375
26393
  responses:
@@ -26410,44 +26428,59 @@ paths:
26410
26428
  title: Email Forward Id
26411
26429
  type: string
26412
26430
  x-typeid-prefix: email_forward
26413
- - in: query
26431
+ - description: Sort field (log_id, domain, sender_email, recipient_email, forward_email,
26432
+ final_status, created_on, synced_on)
26433
+ in: query
26414
26434
  name: sort_by
26415
26435
  required: false
26416
26436
  schema:
26417
26437
  $ref: '#/components/schemas/EmailForwardLogSortField'
26418
26438
  default: created_on
26419
- - in: query
26439
+ description: Sort field (log_id, domain, sender_email, recipient_email,
26440
+ forward_email, final_status, created_on, synced_on)
26441
+ - description: Sort order (asc, desc)
26442
+ in: query
26420
26443
  name: sort_order
26421
26444
  required: false
26422
26445
  schema:
26423
26446
  $ref: '#/components/schemas/SortOrder'
26424
26447
  default: desc
26425
- - in: query
26448
+ description: Sort order (asc, desc)
26449
+ - description: Records per page
26450
+ in: query
26426
26451
  name: page_size
26427
26452
  required: false
26428
26453
  schema:
26429
26454
  default: 50
26455
+ description: Records per page
26430
26456
  maximum: 1000
26431
26457
  minimum: 1
26432
26458
  title: Page Size
26433
26459
  type: integer
26434
- - in: query
26460
+ - description: Page number
26461
+ in: query
26435
26462
  name: page
26436
26463
  required: false
26437
26464
  schema:
26438
26465
  default: 1
26466
+ description: Page number
26439
26467
  minimum: 1
26440
26468
  title: Page
26441
26469
  type: integer
26442
- - in: query
26470
+ - description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26471
+ HARD-BOUNCE)
26472
+ in: query
26443
26473
  name: final_status
26444
26474
  required: false
26445
26475
  schema:
26446
26476
  anyOf:
26447
26477
  - $ref: '#/components/schemas/EmailForwardLogStatus'
26448
26478
  - type: 'null'
26479
+ description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26480
+ HARD-BOUNCE)
26449
26481
  title: Final Status
26450
- - in: query
26482
+ - description: Filter logs after (RFC3339)
26483
+ in: query
26451
26484
  name: start_time
26452
26485
  required: false
26453
26486
  schema:
@@ -26455,8 +26488,10 @@ paths:
26455
26488
  - format: date-time
26456
26489
  type: string
26457
26490
  - type: 'null'
26491
+ description: Filter logs after (RFC3339)
26458
26492
  title: Start Time
26459
- - in: query
26493
+ - description: Filter logs before (RFC3339)
26494
+ in: query
26460
26495
  name: end_time
26461
26496
  required: false
26462
26497
  schema:
@@ -26464,6 +26499,7 @@ paths:
26464
26499
  - format: date-time
26465
26500
  type: string
26466
26501
  - type: 'null'
26502
+ description: Filter logs before (RFC3339)
26467
26503
  title: End Time
26468
26504
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26469
26505
  responses:
@@ -26492,84 +26528,107 @@ paths:
26492
26528
  description: Retrieve all paginated audit logs with optional filtering and sorting
26493
26529
  operationId: get_object_logs_v1_archive_object_logs_get
26494
26530
  parameters:
26495
- - in: query
26531
+ - description: Sort field (object_log_id, object_id, object_type, action, created_on,
26532
+ organization_id, server_request_id, performed_by_type, performed_by_id)
26533
+ in: query
26496
26534
  name: sort_by
26497
26535
  required: false
26498
26536
  schema:
26499
26537
  $ref: '#/components/schemas/ObjectLogSortField'
26500
26538
  default: created_on
26501
- - in: query
26539
+ description: Sort field (object_log_id, object_id, object_type, action,
26540
+ created_on, organization_id, server_request_id, performed_by_type, performed_by_id)
26541
+ - description: Sort order (asc, desc)
26542
+ in: query
26502
26543
  name: sort_order
26503
26544
  required: false
26504
26545
  schema:
26505
26546
  $ref: '#/components/schemas/SortOrder'
26506
26547
  default: desc
26507
- - in: query
26548
+ description: Sort order (asc, desc)
26549
+ - description: Records per page
26550
+ in: query
26508
26551
  name: page_size
26509
26552
  required: false
26510
26553
  schema:
26511
26554
  default: 50
26555
+ description: Records per page
26512
26556
  maximum: 1000
26513
26557
  minimum: 1
26514
26558
  title: Page Size
26515
26559
  type: integer
26516
- - in: query
26560
+ - description: Page number
26561
+ in: query
26517
26562
  name: page
26518
26563
  required: false
26519
26564
  schema:
26520
26565
  default: 1
26566
+ description: Page number
26521
26567
  minimum: 1
26522
26568
  title: Page
26523
26569
  type: integer
26524
- - in: query
26570
+ - description: Filter by specific log UUID
26571
+ in: query
26525
26572
  name: object_log_id
26526
26573
  required: false
26527
26574
  schema:
26528
26575
  anyOf:
26529
26576
  - type: string
26530
26577
  - type: 'null'
26578
+ description: Filter by specific log UUID
26531
26579
  title: Object Log Id
26532
- - in: query
26580
+ - description: Filter by object type
26581
+ in: query
26533
26582
  name: object_type
26534
26583
  required: false
26535
26584
  schema:
26536
26585
  anyOf:
26537
26586
  - type: string
26538
26587
  - type: 'null'
26588
+ description: Filter by object type
26539
26589
  title: Object Type
26540
- - in: query
26590
+ - description: Filter by action
26591
+ in: query
26541
26592
  name: action
26542
26593
  required: false
26543
26594
  schema:
26544
26595
  anyOf:
26545
26596
  - $ref: '#/components/schemas/ObjectEventType'
26546
26597
  - type: 'null'
26598
+ description: Filter by action
26547
26599
  title: Action
26548
- - in: query
26600
+ - description: Filter by server request ID
26601
+ in: query
26549
26602
  name: server_request_id
26550
26603
  required: false
26551
26604
  schema:
26552
26605
  anyOf:
26553
26606
  - type: string
26554
26607
  - type: 'null'
26608
+ description: Filter by server request ID
26555
26609
  title: Server Request Id
26556
- - in: query
26610
+ - description: Filter by performer type
26611
+ in: query
26557
26612
  name: performed_by_type
26558
26613
  required: false
26559
26614
  schema:
26560
26615
  anyOf:
26561
26616
  - $ref: '#/components/schemas/ExecutingEntity'
26562
26617
  - type: 'null'
26618
+ description: Filter by performer type
26563
26619
  title: Performed By Type
26564
- - in: query
26620
+ - description: Filter by performer ID (TypeID)
26621
+ in: query
26565
26622
  name: performed_by_id
26566
26623
  required: false
26567
26624
  schema:
26568
26625
  anyOf:
26569
26626
  - type: string
26570
26627
  - type: 'null'
26628
+ description: Filter by performer ID (TypeID)
26571
26629
  title: Performed By Id
26572
- - in: query
26630
+ - description: 'Upper bound: created_on <= value (RFC3339)'
26631
+ in: query
26573
26632
  name: created_before
26574
26633
  required: false
26575
26634
  schema:
@@ -26577,8 +26636,10 @@ paths:
26577
26636
  - format: date-time
26578
26637
  type: string
26579
26638
  - type: 'null'
26639
+ description: 'Upper bound: created_on <= value (RFC3339)'
26580
26640
  title: Created Before
26581
- - in: query
26641
+ - description: 'Lower bound: created_on >= value (RFC3339)'
26642
+ in: query
26582
26643
  name: created_after
26583
26644
  required: false
26584
26645
  schema:
@@ -26586,14 +26647,17 @@ paths:
26586
26647
  - format: date-time
26587
26648
  type: string
26588
26649
  - type: 'null'
26650
+ description: 'Lower bound: created_on >= value (RFC3339)'
26589
26651
  title: Created After
26590
- - in: query
26652
+ - description: Filter by object ID (TypeID)
26653
+ in: query
26591
26654
  name: object_id
26592
26655
  required: false
26593
26656
  schema:
26594
26657
  anyOf:
26595
26658
  - type: string
26596
26659
  - type: 'null'
26660
+ description: Filter by object ID (TypeID)
26597
26661
  title: Object Id
26598
26662
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26599
26663
  responses:
@@ -26629,84 +26693,107 @@ paths:
26629
26693
  schema:
26630
26694
  title: Object Id
26631
26695
  type: string
26632
- - in: query
26696
+ - description: Sort field (object_log_id, object_id, object_type, action, created_on,
26697
+ organization_id, server_request_id, performed_by_type, performed_by_id)
26698
+ in: query
26633
26699
  name: sort_by
26634
26700
  required: false
26635
26701
  schema:
26636
26702
  $ref: '#/components/schemas/ObjectLogSortField'
26637
26703
  default: created_on
26638
- - in: query
26704
+ description: Sort field (object_log_id, object_id, object_type, action,
26705
+ created_on, organization_id, server_request_id, performed_by_type, performed_by_id)
26706
+ - description: Sort order (asc, desc)
26707
+ in: query
26639
26708
  name: sort_order
26640
26709
  required: false
26641
26710
  schema:
26642
26711
  $ref: '#/components/schemas/SortOrder'
26643
26712
  default: desc
26644
- - in: query
26713
+ description: Sort order (asc, desc)
26714
+ - description: Records per page
26715
+ in: query
26645
26716
  name: page_size
26646
26717
  required: false
26647
26718
  schema:
26648
26719
  default: 50
26720
+ description: Records per page
26649
26721
  maximum: 1000
26650
26722
  minimum: 1
26651
26723
  title: Page Size
26652
26724
  type: integer
26653
- - in: query
26725
+ - description: Page number
26726
+ in: query
26654
26727
  name: page
26655
26728
  required: false
26656
26729
  schema:
26657
26730
  default: 1
26731
+ description: Page number
26658
26732
  minimum: 1
26659
26733
  title: Page
26660
26734
  type: integer
26661
- - in: query
26735
+ - description: Filter by specific log UUID
26736
+ in: query
26662
26737
  name: object_log_id
26663
26738
  required: false
26664
26739
  schema:
26665
26740
  anyOf:
26666
26741
  - type: string
26667
26742
  - type: 'null'
26743
+ description: Filter by specific log UUID
26668
26744
  title: Object Log Id
26669
- - in: query
26745
+ - description: Filter by object type
26746
+ in: query
26670
26747
  name: object_type
26671
26748
  required: false
26672
26749
  schema:
26673
26750
  anyOf:
26674
26751
  - type: string
26675
26752
  - type: 'null'
26753
+ description: Filter by object type
26676
26754
  title: Object Type
26677
- - in: query
26755
+ - description: Filter by action
26756
+ in: query
26678
26757
  name: action
26679
26758
  required: false
26680
26759
  schema:
26681
26760
  anyOf:
26682
26761
  - $ref: '#/components/schemas/ObjectEventType'
26683
26762
  - type: 'null'
26763
+ description: Filter by action
26684
26764
  title: Action
26685
- - in: query
26765
+ - description: Filter by server request ID
26766
+ in: query
26686
26767
  name: server_request_id
26687
26768
  required: false
26688
26769
  schema:
26689
26770
  anyOf:
26690
26771
  - type: string
26691
26772
  - type: 'null'
26773
+ description: Filter by server request ID
26692
26774
  title: Server Request Id
26693
- - in: query
26775
+ - description: Filter by performer type
26776
+ in: query
26694
26777
  name: performed_by_type
26695
26778
  required: false
26696
26779
  schema:
26697
26780
  anyOf:
26698
26781
  - $ref: '#/components/schemas/ExecutingEntity'
26699
26782
  - type: 'null'
26783
+ description: Filter by performer type
26700
26784
  title: Performed By Type
26701
- - in: query
26785
+ - description: Filter by performer ID (TypeID)
26786
+ in: query
26702
26787
  name: performed_by_id
26703
26788
  required: false
26704
26789
  schema:
26705
26790
  anyOf:
26706
26791
  - type: string
26707
26792
  - type: 'null'
26793
+ description: Filter by performer ID (TypeID)
26708
26794
  title: Performed By Id
26709
- - in: query
26795
+ - description: 'Upper bound: created_on <= value (RFC3339)'
26796
+ in: query
26710
26797
  name: created_before
26711
26798
  required: false
26712
26799
  schema:
@@ -26714,8 +26801,10 @@ paths:
26714
26801
  - format: date-time
26715
26802
  type: string
26716
26803
  - type: 'null'
26804
+ description: 'Upper bound: created_on <= value (RFC3339)'
26717
26805
  title: Created Before
26718
- - in: query
26806
+ - description: 'Lower bound: created_on >= value (RFC3339)'
26807
+ in: query
26719
26808
  name: created_after
26720
26809
  required: false
26721
26810
  schema:
@@ -26723,6 +26812,7 @@ paths:
26723
26812
  - format: date-time
26724
26813
  type: string
26725
26814
  - type: 'null'
26815
+ description: 'Lower bound: created_on >= value (RFC3339)'
26726
26816
  title: Created After
26727
26817
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26728
26818
  responses:
@@ -26751,18 +26841,26 @@ paths:
26751
26841
  description: Retrieves a paginated list of request history logs
26752
26842
  operationId: get_request_history_v1_archive_request_history_get
26753
26843
  parameters:
26754
- - in: query
26844
+ - description: Sort field (request_history_id, method, path, status_code, duration,
26845
+ client_ip, server_request_id, performed_by_type, performed_by_id, created_on,
26846
+ request_started_at, request_completed_at, organization_id)
26847
+ in: query
26755
26848
  name: sort_by
26756
26849
  required: false
26757
26850
  schema:
26758
26851
  $ref: '#/components/schemas/RequestHistorySortField'
26759
26852
  default: created_on
26760
- - in: query
26853
+ description: Sort field (request_history_id, method, path, status_code,
26854
+ duration, client_ip, server_request_id, performed_by_type, performed_by_id,
26855
+ created_on, request_started_at, request_completed_at, organization_id)
26856
+ - description: Sort order (asc, desc)
26857
+ in: query
26761
26858
  name: sort_order
26762
26859
  required: false
26763
26860
  schema:
26764
26861
  $ref: '#/components/schemas/SortOrder'
26765
26862
  default: desc
26863
+ description: Sort order (asc, desc)
26766
26864
  - in: query
26767
26865
  name: page_size
26768
26866
  required: false
@@ -26780,63 +26878,78 @@ paths:
26780
26878
  minimum: 1
26781
26879
  title: Page
26782
26880
  type: integer
26783
- - in: query
26881
+ - description: HTTP method filter (GET, POST, etc.)
26882
+ in: query
26784
26883
  name: method
26785
26884
  required: false
26786
26885
  schema:
26787
26886
  anyOf:
26788
26887
  - $ref: '#/components/schemas/HTTPMethod'
26789
26888
  - type: 'null'
26889
+ description: HTTP method filter (GET, POST, etc.)
26790
26890
  title: Method
26791
- - in: query
26891
+ - description: Path filter (supports LIKE queries)
26892
+ in: query
26792
26893
  name: path
26793
26894
  required: false
26794
26895
  schema:
26795
26896
  anyOf:
26796
26897
  - type: string
26797
26898
  - type: 'null'
26899
+ description: Path filter (supports LIKE queries)
26798
26900
  title: Path
26799
- - in: query
26901
+ - description: Exact status code filter
26902
+ in: query
26800
26903
  name: status_code
26801
26904
  required: false
26802
26905
  schema:
26803
26906
  anyOf:
26804
26907
  - type: integer
26805
26908
  - type: 'null'
26909
+ description: Exact status code filter
26806
26910
  title: Status Code
26807
- - in: query
26911
+ - description: Minimum status code filter
26912
+ in: query
26808
26913
  name: min_status_code
26809
26914
  required: false
26810
26915
  schema:
26811
26916
  anyOf:
26812
26917
  - type: integer
26813
26918
  - type: 'null'
26919
+ description: Minimum status code filter
26814
26920
  title: Min Status Code
26815
- - in: query
26921
+ - description: Maximum status code filter
26922
+ in: query
26816
26923
  name: max_status_code
26817
26924
  required: false
26818
26925
  schema:
26819
26926
  anyOf:
26820
26927
  - type: integer
26821
26928
  - type: 'null'
26929
+ description: Maximum status code filter
26822
26930
  title: Max Status Code
26823
- - in: query
26931
+ - description: Minimum duration in milliseconds
26932
+ in: query
26824
26933
  name: min_duration
26825
26934
  required: false
26826
26935
  schema:
26827
26936
  anyOf:
26828
26937
  - type: number
26829
26938
  - type: 'null'
26939
+ description: Minimum duration in milliseconds
26830
26940
  title: Min Duration
26831
- - in: query
26941
+ - description: Maximum duration in milliseconds
26942
+ in: query
26832
26943
  name: max_duration
26833
26944
  required: false
26834
26945
  schema:
26835
26946
  anyOf:
26836
26947
  - type: number
26837
26948
  - type: 'null'
26949
+ description: Maximum duration in milliseconds
26838
26950
  title: Max Duration
26839
- - in: query
26951
+ - description: Client IP address filter
26952
+ in: query
26840
26953
  name: client_ip
26841
26954
  required: false
26842
26955
  schema:
@@ -26844,32 +26957,40 @@ paths:
26844
26957
  - format: ipvanyaddress
26845
26958
  type: string
26846
26959
  - type: 'null'
26960
+ description: Client IP address filter
26847
26961
  title: Client Ip
26848
- - in: query
26962
+ - description: Server request ID filter
26963
+ in: query
26849
26964
  name: server_request_id
26850
26965
  required: false
26851
26966
  schema:
26852
26967
  anyOf:
26853
26968
  - type: string
26854
26969
  - type: 'null'
26970
+ description: Server request ID filter
26855
26971
  title: Server Request Id
26856
- - in: query
26972
+ - description: Performed by type filter
26973
+ in: query
26857
26974
  name: performed_by_type
26858
26975
  required: false
26859
26976
  schema:
26860
26977
  anyOf:
26861
26978
  - $ref: '#/components/schemas/ExecutingEntity'
26862
26979
  - type: 'null'
26980
+ description: Performed by type filter
26863
26981
  title: Performed By Type
26864
- - in: query
26982
+ - description: Performed by ID filter
26983
+ in: query
26865
26984
  name: performed_by_id
26866
26985
  required: false
26867
26986
  schema:
26868
26987
  anyOf:
26869
26988
  - type: string
26870
26989
  - type: 'null'
26990
+ description: Performed by ID filter
26871
26991
  title: Performed By Id
26872
- - in: query
26992
+ - description: 'Upper bound: request_started_at <= value (RFC3339)'
26993
+ in: query
26873
26994
  name: request_started_before
26874
26995
  required: false
26875
26996
  schema:
@@ -26877,8 +26998,10 @@ paths:
26877
26998
  - format: date-time
26878
26999
  type: string
26879
27000
  - type: 'null'
27001
+ description: 'Upper bound: request_started_at <= value (RFC3339)'
26880
27002
  title: Request Started Before
26881
- - in: query
27003
+ - description: 'Lower bound: request_started_at >= value (RFC3339)'
27004
+ in: query
26882
27005
  name: request_started_after
26883
27006
  required: false
26884
27007
  schema:
@@ -26886,6 +27009,7 @@ paths:
26886
27009
  - format: date-time
26887
27010
  type: string
26888
27011
  - type: 'null'
27012
+ description: 'Lower bound: request_started_at >= value (RFC3339)'
26889
27013
  title: Request Started After
26890
27014
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26891
27015
  responses:
@@ -27271,18 +27395,22 @@ paths:
27271
27395
  minimum: 1
27272
27396
  title: Page Size
27273
27397
  type: integer
27274
- - in: query
27398
+ - description: Field to sort by
27399
+ in: query
27275
27400
  name: sort_by
27276
27401
  required: false
27277
27402
  schema:
27278
27403
  $ref: '#/components/schemas/ContactSortField'
27279
27404
  default: created_on
27280
- - in: query
27405
+ description: Field to sort by
27406
+ - description: Sort order direction
27407
+ in: query
27281
27408
  name: sort_order
27282
27409
  required: false
27283
27410
  schema:
27284
27411
  $ref: '#/components/schemas/SortOrder'
27285
27412
  default: desc
27413
+ description: Sort order direction
27286
27414
  - description: Filter by contact status tag types. Can be specified multiple
27287
27415
  times.
27288
27416
  in: query
@@ -27297,12 +27425,22 @@ paths:
27297
27425
  description: Filter by contact status tag types. Can be specified multiple
27298
27426
  times.
27299
27427
  title: Status Tags
27300
- - in: query
27428
+ - description: 'How to combine status_tags: ''match_any'' returns objects with
27429
+ at least one of the tags, ''match_all'' returns objects with every tag,
27430
+ ''match_none'' returns objects with none of the tags, including objects
27431
+ that carry no status tags at all. Has no effect unless one or more status_tags
27432
+ are supplied.'
27433
+ in: query
27301
27434
  name: status_tag_mode
27302
27435
  required: false
27303
27436
  schema:
27304
27437
  $ref: '#/components/schemas/TagFilterMode'
27305
27438
  default: match_any
27439
+ description: 'How to combine status_tags: ''match_any'' returns objects
27440
+ with at least one of the tags, ''match_all'' returns objects with every
27441
+ tag, ''match_none'' returns objects with none of the tags, including objects
27442
+ that carry no status tags at all. Has no effect unless one or more status_tags
27443
+ are supplied.'
27306
27444
  - description: Filter by user tag IDs. Can be specified multiple times.
27307
27445
  in: query
27308
27446
  name: tag_ids
@@ -27320,69 +27458,106 @@ paths:
27320
27458
  - type: 'null'
27321
27459
  description: Filter by user tag IDs. Can be specified multiple times.
27322
27460
  title: Tag Ids
27323
- - in: query
27461
+ - description: 'How to combine tag_ids: ''match_any'' returns objects with at
27462
+ least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
27463
+ returns objects with none of the tags, including objects that carry no user
27464
+ tags at all. Has no effect unless one or more tag_ids are supplied; to filter
27465
+ on whether an object has any user tag, use has_tags.'
27466
+ in: query
27324
27467
  name: tag_mode
27325
27468
  required: false
27326
27469
  schema:
27327
27470
  $ref: '#/components/schemas/TagFilterMode'
27328
27471
  default: match_any
27329
- - in: query
27472
+ description: 'How to combine tag_ids: ''match_any'' returns objects with
27473
+ at least one of the tags, ''match_all'' returns objects with every tag,
27474
+ ''match_none'' returns objects with none of the tags, including objects
27475
+ that carry no user tags at all. Has no effect unless one or more tag_ids
27476
+ are supplied; to filter on whether an object has any user tag, use has_tags.'
27477
+ - description: true returns only objects that carry at least one user tag, false
27478
+ only objects that carry none. Status tags are not counted. Combines with
27479
+ tag_ids and the other filters.
27480
+ in: query
27330
27481
  name: has_tags
27331
27482
  required: false
27332
27483
  schema:
27333
27484
  anyOf:
27334
27485
  - type: boolean
27335
27486
  - type: 'null'
27487
+ description: true returns only objects that carry at least one user tag,
27488
+ false only objects that carry none. Status tags are not counted. Combines
27489
+ with tag_ids and the other filters.
27336
27490
  title: Has Tags
27337
- - in: query
27491
+ - description: Filter by exact first name
27492
+ in: query
27338
27493
  name: first_name
27339
27494
  required: false
27340
27495
  schema:
27341
27496
  anyOf:
27342
27497
  - type: string
27343
27498
  - type: 'null'
27499
+ description: Filter by exact first name
27344
27500
  title: First Name
27345
- - in: query
27501
+ - description: Filter by exact last name
27502
+ in: query
27346
27503
  name: last_name
27347
27504
  required: false
27348
27505
  schema:
27349
27506
  anyOf:
27350
27507
  - type: string
27351
27508
  - type: 'null'
27509
+ description: Filter by exact last name
27352
27510
  title: Last Name
27353
- - in: query
27511
+ - description: Filter by exact email address
27512
+ in: query
27354
27513
  name: email
27355
27514
  required: false
27356
27515
  schema:
27357
27516
  anyOf:
27358
27517
  - type: string
27359
27518
  - type: 'null'
27519
+ description: Filter by exact email address
27360
27520
  title: Email
27361
- - in: query
27521
+ - description: Search contacts by name, email, organization, or contact ID.
27522
+ Multiple whitespace-separated terms must all match (as substrings), so a
27523
+ full "First Last" name matches across the separate first- and last-name
27524
+ columns. A contact ID is matched exactly.
27525
+ in: query
27362
27526
  name: search
27363
27527
  required: false
27364
27528
  schema:
27365
27529
  anyOf:
27366
27530
  - type: string
27367
27531
  - type: 'null'
27532
+ description: Search contacts by name, email, organization, or contact ID.
27533
+ Multiple whitespace-separated terms must all match (as substrings), so
27534
+ a full "First Last" name matches across the separate first- and last-name
27535
+ columns. A contact ID is matched exactly.
27368
27536
  title: Search
27369
- - in: query
27537
+ - description: Filter by country
27538
+ in: query
27370
27539
  name: country
27371
27540
  required: false
27372
27541
  schema:
27373
27542
  anyOf:
27374
27543
  - type: string
27375
27544
  - type: 'null'
27545
+ description: Filter by country
27376
27546
  title: Country
27377
- - in: query
27547
+ - description: Filter by whether the contact is in use by any domain (true =
27548
+ has domains, false = none)
27549
+ in: query
27378
27550
  name: in_use
27379
27551
  required: false
27380
27552
  schema:
27381
27553
  anyOf:
27382
27554
  - type: boolean
27383
27555
  - type: 'null'
27556
+ description: Filter by whether the contact is in use by any domain (true
27557
+ = has domains, false = none)
27384
27558
  title: In Use
27385
- - in: query
27559
+ - description: Filter contacts created after this date
27560
+ in: query
27386
27561
  name: created_after
27387
27562
  required: false
27388
27563
  schema:
@@ -27390,8 +27565,10 @@ paths:
27390
27565
  - format: date-time
27391
27566
  type: string
27392
27567
  - type: 'null'
27568
+ description: Filter contacts created after this date
27393
27569
  title: Created After
27394
- - in: query
27570
+ - description: Filter contacts created before this date
27571
+ in: query
27395
27572
  name: created_before
27396
27573
  required: false
27397
27574
  schema:
@@ -27399,6 +27576,7 @@ paths:
27399
27576
  - format: date-time
27400
27577
  type: string
27401
27578
  - type: 'null'
27579
+ description: Filter contacts created before this date
27402
27580
  title: Created Before
27403
27581
  - description: Include additional data in the response. Can be specified multiple
27404
27582
  times.
@@ -27511,33 +27689,41 @@ paths:
27511
27689
  minimum: 1
27512
27690
  title: Page Size
27513
27691
  type: integer
27514
- - in: query
27692
+ - description: Field to sort by
27693
+ in: query
27515
27694
  name: sort_by
27516
27695
  required: false
27517
27696
  schema:
27518
27697
  $ref: '#/components/schemas/ContactAttributeSetSortField'
27519
27698
  default: created_on
27520
- - in: query
27699
+ description: Field to sort by
27700
+ - description: Sort order direction
27701
+ in: query
27521
27702
  name: sort_order
27522
27703
  required: false
27523
27704
  schema:
27524
27705
  $ref: '#/components/schemas/SortOrder'
27525
27706
  default: desc
27526
- - in: query
27707
+ description: Sort order direction
27708
+ - description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
27709
+ in: query
27527
27710
  name: tld
27528
27711
  required: false
27529
27712
  schema:
27530
27713
  anyOf:
27531
27714
  - type: string
27532
27715
  - type: 'null'
27716
+ description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
27533
27717
  title: Tld
27534
- - in: query
27718
+ - description: Filter by label (contains, case-insensitive)
27719
+ in: query
27535
27720
  name: label
27536
27721
  required: false
27537
27722
  schema:
27538
27723
  anyOf:
27539
27724
  - type: string
27540
27725
  - type: 'null'
27726
+ description: Filter by label (contains, case-insensitive)
27541
27727
  title: Label
27542
27728
  - $ref: '#/components/parameters/DatetimeFormatHeader'
27543
27729
  responses:
@@ -28622,18 +28808,22 @@ paths:
28622
28808
  minimum: 1
28623
28809
  title: Page Size
28624
28810
  type: integer
28625
- - in: query
28811
+ - description: Field to sort by
28812
+ in: query
28626
28813
  name: sort_by
28627
28814
  required: false
28628
28815
  schema:
28629
28816
  $ref: '#/components/schemas/ZoneSortField'
28630
28817
  default: created_on
28631
- - in: query
28818
+ description: Field to sort by
28819
+ - description: Sort order direction
28820
+ in: query
28632
28821
  name: sort_order
28633
28822
  required: false
28634
28823
  schema:
28635
28824
  $ref: '#/components/schemas/SortOrder'
28636
28825
  default: desc
28826
+ description: Sort order direction
28637
28827
  - description: Filter by user tag IDs. Can be specified multiple times.
28638
28828
  in: query
28639
28829
  name: tag_ids
@@ -28651,53 +28841,78 @@ paths:
28651
28841
  - type: 'null'
28652
28842
  description: Filter by user tag IDs. Can be specified multiple times.
28653
28843
  title: Tag Ids
28654
- - in: query
28844
+ - description: 'How to combine tag_ids: ''match_any'' returns objects with at
28845
+ least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
28846
+ returns objects with none of the tags, including objects that carry no user
28847
+ tags at all. Has no effect unless one or more tag_ids are supplied; to filter
28848
+ on whether an object has any user tag, use has_tags.'
28849
+ in: query
28655
28850
  name: tag_mode
28656
28851
  required: false
28657
28852
  schema:
28658
28853
  $ref: '#/components/schemas/TagFilterMode'
28659
28854
  default: match_any
28660
- - in: query
28855
+ description: 'How to combine tag_ids: ''match_any'' returns objects with
28856
+ at least one of the tags, ''match_all'' returns objects with every tag,
28857
+ ''match_none'' returns objects with none of the tags, including objects
28858
+ that carry no user tags at all. Has no effect unless one or more tag_ids
28859
+ are supplied; to filter on whether an object has any user tag, use has_tags.'
28860
+ - description: true returns only objects that carry at least one user tag, false
28861
+ only objects that carry none. Status tags are not counted. Combines with
28862
+ tag_ids and the other filters.
28863
+ in: query
28661
28864
  name: has_tags
28662
28865
  required: false
28663
28866
  schema:
28664
28867
  anyOf:
28665
28868
  - type: boolean
28666
28869
  - type: 'null'
28870
+ description: true returns only objects that carry at least one user tag,
28871
+ false only objects that carry none. Status tags are not counted. Combines
28872
+ with tag_ids and the other filters.
28667
28873
  title: Has Tags
28668
- - in: query
28874
+ - description: Filter by DNSSEC status
28875
+ in: query
28669
28876
  name: dnssec_status
28670
28877
  required: false
28671
28878
  schema:
28672
28879
  anyOf:
28673
28880
  - $ref: '#/components/schemas/DnssecStatus'
28674
28881
  - type: 'null'
28882
+ description: Filter by DNSSEC status
28675
28883
  title: Dnssec Status
28676
- - in: query
28884
+ - description: Filter by exact zone name
28885
+ in: query
28677
28886
  name: name
28678
28887
  required: false
28679
28888
  schema:
28680
28889
  anyOf:
28681
28890
  - type: string
28682
28891
  - type: 'null'
28892
+ description: Filter by exact zone name
28683
28893
  title: Name
28684
- - in: query
28894
+ - description: Search zones by name (contains)
28895
+ in: query
28685
28896
  name: search
28686
28897
  required: false
28687
28898
  schema:
28688
28899
  anyOf:
28689
28900
  - type: string
28690
28901
  - type: 'null'
28902
+ description: Search zones by name (contains)
28691
28903
  title: Search
28692
- - in: query
28904
+ - description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
28905
+ in: query
28693
28906
  name: suffix
28694
28907
  required: false
28695
28908
  schema:
28696
28909
  anyOf:
28697
28910
  - type: string
28698
28911
  - type: 'null'
28912
+ description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
28699
28913
  title: Suffix
28700
- - in: query
28914
+ - description: Filter zones by the vanity nameserver set branding them
28915
+ in: query
28701
28916
  name: vanity_nameserver_set_id
28702
28917
  required: false
28703
28918
  schema:
@@ -28709,8 +28924,10 @@ paths:
28709
28924
  type: string
28710
28925
  x-typeid-prefix: vns
28711
28926
  - type: 'null'
28927
+ description: Filter zones by the vanity nameserver set branding them
28712
28928
  title: Vanity Nameserver Set Id
28713
- - in: query
28929
+ - description: Filter zones created after this date
28930
+ in: query
28714
28931
  name: created_after
28715
28932
  required: false
28716
28933
  schema:
@@ -28718,8 +28935,10 @@ paths:
28718
28935
  - format: date-time
28719
28936
  type: string
28720
28937
  - type: 'null'
28938
+ description: Filter zones created after this date
28721
28939
  title: Created After
28722
- - in: query
28940
+ - description: Filter zones created before this date
28941
+ in: query
28723
28942
  name: created_before
28724
28943
  required: false
28725
28944
  schema:
@@ -28727,8 +28946,10 @@ paths:
28727
28946
  - format: date-time
28728
28947
  type: string
28729
28948
  - type: 'null'
28949
+ description: Filter zones created before this date
28730
28950
  title: Created Before
28731
- - in: query
28951
+ - description: Filter zones updated after this date
28952
+ in: query
28732
28953
  name: updated_after
28733
28954
  required: false
28734
28955
  schema:
@@ -28736,8 +28957,10 @@ paths:
28736
28957
  - format: date-time
28737
28958
  type: string
28738
28959
  - type: 'null'
28960
+ description: Filter zones updated after this date
28739
28961
  title: Updated After
28740
- - in: query
28962
+ - description: Filter zones updated before this date
28963
+ in: query
28741
28964
  name: updated_before
28742
28965
  required: false
28743
28966
  schema:
@@ -28745,6 +28968,7 @@ paths:
28745
28968
  - format: date-time
28746
28969
  type: string
28747
28970
  - type: 'null'
28971
+ description: Filter zones updated before this date
28748
28972
  title: Updated Before
28749
28973
  - description: Include additional data in the response. Can be specified multiple
28750
28974
  times.
@@ -29133,26 +29357,32 @@ paths:
29133
29357
  minimum: 1
29134
29358
  title: Page Size
29135
29359
  type: integer
29136
- - in: query
29360
+ - description: Search by zone name
29361
+ in: query
29137
29362
  name: search
29138
29363
  required: false
29139
29364
  schema:
29140
29365
  anyOf:
29141
29366
  - type: string
29142
29367
  - type: 'null'
29368
+ description: Search by zone name
29143
29369
  title: Search
29144
- - in: query
29370
+ - description: Field to sort by
29371
+ in: query
29145
29372
  name: sort_by
29146
29373
  required: false
29147
29374
  schema:
29148
29375
  $ref: '#/components/schemas/DomainForwardZoneSortField'
29149
29376
  default: created_on
29150
- - in: query
29377
+ description: Field to sort by
29378
+ - description: Sort order direction
29379
+ in: query
29151
29380
  name: sort_order
29152
29381
  required: false
29153
29382
  schema:
29154
29383
  $ref: '#/components/schemas/SortOrder'
29155
29384
  default: desc
29385
+ description: Sort order direction
29156
29386
  - $ref: '#/components/parameters/DatetimeFormatHeader'
29157
29387
  responses:
29158
29388
  '200':
@@ -29255,26 +29485,32 @@ paths:
29255
29485
  minimum: 1
29256
29486
  title: Page Size
29257
29487
  type: integer
29258
- - in: query
29488
+ - description: Search by zone name
29489
+ in: query
29259
29490
  name: search
29260
29491
  required: false
29261
29492
  schema:
29262
29493
  anyOf:
29263
29494
  - type: string
29264
29495
  - type: 'null'
29496
+ description: Search by zone name
29265
29497
  title: Search
29266
- - in: query
29498
+ - description: Field to sort by
29499
+ in: query
29267
29500
  name: sort_by
29268
29501
  required: false
29269
29502
  schema:
29270
29503
  $ref: '#/components/schemas/EmailForwardZoneSortField'
29271
29504
  default: created_on
29272
- - in: query
29505
+ description: Field to sort by
29506
+ - description: Sort order direction
29507
+ in: query
29273
29508
  name: sort_order
29274
29509
  required: false
29275
29510
  schema:
29276
29511
  $ref: '#/components/schemas/SortOrder'
29277
29512
  default: desc
29513
+ description: Sort order direction
29278
29514
  - $ref: '#/components/parameters/DatetimeFormatHeader'
29279
29515
  responses:
29280
29516
  '200':
@@ -30381,26 +30617,32 @@ paths:
30381
30617
  minimum: 1
30382
30618
  title: Page Size
30383
30619
  type: integer
30384
- - in: query
30620
+ - description: Search by hostname
30621
+ in: query
30385
30622
  name: search
30386
30623
  required: false
30387
30624
  schema:
30388
30625
  anyOf:
30389
30626
  - type: string
30390
30627
  - type: 'null'
30628
+ description: Search by hostname
30391
30629
  title: Search
30392
- - in: query
30630
+ - description: Field to sort by
30631
+ in: query
30393
30632
  name: sort_by
30394
30633
  required: false
30395
30634
  schema:
30396
30635
  $ref: '#/components/schemas/DomainForwardSortField'
30397
30636
  default: created_on
30398
- - in: query
30637
+ description: Field to sort by
30638
+ - description: Sort order direction
30639
+ in: query
30399
30640
  name: sort_order
30400
30641
  required: false
30401
30642
  schema:
30402
30643
  $ref: '#/components/schemas/SortOrder'
30403
30644
  default: desc
30645
+ description: Sort order direction
30404
30646
  - $ref: '#/components/parameters/DatetimeFormatHeader'
30405
30647
  responses:
30406
30648
  '200':
@@ -33010,18 +33252,22 @@ paths:
33010
33252
  minimum: 1
33011
33253
  title: Page Size
33012
33254
  type: integer
33013
- - in: query
33255
+ - description: Field to sort by
33256
+ in: query
33014
33257
  name: sort_by
33015
33258
  required: false
33016
33259
  schema:
33017
33260
  $ref: '#/components/schemas/DomainSortField'
33018
33261
  default: created_on
33019
- - in: query
33262
+ description: Field to sort by
33263
+ - description: Sort order direction
33264
+ in: query
33020
33265
  name: sort_order
33021
33266
  required: false
33022
33267
  schema:
33023
33268
  $ref: '#/components/schemas/SortOrder'
33024
33269
  default: desc
33270
+ description: Sort order direction
33025
33271
  - description: Filter by status tag types. Can be specified multiple times.
33026
33272
  in: query
33027
33273
  name: status_tags
@@ -33034,12 +33280,22 @@ paths:
33034
33280
  - type: 'null'
33035
33281
  description: Filter by status tag types. Can be specified multiple times.
33036
33282
  title: Status Tags
33037
- - in: query
33283
+ - description: 'How to combine status_tags: ''match_any'' returns objects with
33284
+ at least one of the tags, ''match_all'' returns objects with every tag,
33285
+ ''match_none'' returns objects with none of the tags, including objects
33286
+ that carry no status tags at all. Has no effect unless one or more status_tags
33287
+ are supplied.'
33288
+ in: query
33038
33289
  name: status_tag_mode
33039
33290
  required: false
33040
33291
  schema:
33041
33292
  $ref: '#/components/schemas/TagFilterMode'
33042
33293
  default: match_any
33294
+ description: 'How to combine status_tags: ''match_any'' returns objects
33295
+ with at least one of the tags, ''match_all'' returns objects with every
33296
+ tag, ''match_none'' returns objects with none of the tags, including objects
33297
+ that carry no status tags at all. Has no effect unless one or more status_tags
33298
+ are supplied.'
33043
33299
  - description: Filter by user tag IDs. Can be specified multiple times.
33044
33300
  in: query
33045
33301
  name: tag_ids
@@ -33057,35 +33313,55 @@ paths:
33057
33313
  - type: 'null'
33058
33314
  description: Filter by user tag IDs. Can be specified multiple times.
33059
33315
  title: Tag Ids
33060
- - in: query
33316
+ - description: 'How to combine tag_ids: ''match_any'' returns objects with at
33317
+ least one of the tags, ''match_all'' returns objects with every tag, ''match_none''
33318
+ returns objects with none of the tags, including objects that carry no user
33319
+ tags at all. Has no effect unless one or more tag_ids are supplied; to filter
33320
+ on whether an object has any user tag, use has_tags.'
33321
+ in: query
33061
33322
  name: tag_mode
33062
33323
  required: false
33063
33324
  schema:
33064
33325
  $ref: '#/components/schemas/TagFilterMode'
33065
33326
  default: match_any
33066
- - in: query
33327
+ description: 'How to combine tag_ids: ''match_any'' returns objects with
33328
+ at least one of the tags, ''match_all'' returns objects with every tag,
33329
+ ''match_none'' returns objects with none of the tags, including objects
33330
+ that carry no user tags at all. Has no effect unless one or more tag_ids
33331
+ are supplied; to filter on whether an object has any user tag, use has_tags.'
33332
+ - description: true returns only objects that carry at least one user tag, false
33333
+ only objects that carry none. Status tags are not counted. Combines with
33334
+ tag_ids and the other filters.
33335
+ in: query
33067
33336
  name: has_tags
33068
33337
  required: false
33069
33338
  schema:
33070
33339
  anyOf:
33071
33340
  - type: boolean
33072
33341
  - type: 'null'
33342
+ description: true returns only objects that carry at least one user tag,
33343
+ false only objects that carry none. Status tags are not counted. Combines
33344
+ with tag_ids and the other filters.
33073
33345
  title: Has Tags
33074
- - in: query
33346
+ - description: Filter by exact domain name
33347
+ in: query
33075
33348
  name: name
33076
33349
  required: false
33077
33350
  schema:
33078
33351
  anyOf:
33079
33352
  - type: string
33080
33353
  - type: 'null'
33354
+ description: Filter by exact domain name
33081
33355
  title: Name
33082
- - in: query
33356
+ - description: Search domains by name (contains) or domain ID (exact match)
33357
+ in: query
33083
33358
  name: search
33084
33359
  required: false
33085
33360
  schema:
33086
33361
  anyOf:
33087
33362
  - type: string
33088
33363
  - type: 'null'
33364
+ description: Search domains by name (contains) or domain ID (exact match)
33089
33365
  title: Search
33090
33366
  - description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
33091
33367
  multiple times (union of all provided values).
@@ -33101,47 +33377,70 @@ paths:
33101
33377
  description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
33102
33378
  multiple times (union of all provided values).
33103
33379
  title: Tld
33104
- - in: query
33380
+ - description: Filter by second-level domain
33381
+ in: query
33105
33382
  name: sld
33106
33383
  required: false
33107
33384
  schema:
33108
33385
  anyOf:
33109
33386
  - type: string
33110
33387
  - type: 'null'
33388
+ description: Filter by second-level domain
33111
33389
  title: Sld
33112
- - in: query
33390
+ - description: Filter domains whose nameserver hostnames contain this text,
33391
+ e.g. `cloudflare` or `ns1.example.com`. Matches the nameservers the domain
33392
+ currently delegates to. The text is matched literally, so `%` and `_` are
33393
+ not wildcards; a trailing dot on a single label anchors at a label boundary,
33394
+ so `ns1.` matches `ns1.example.com` but not `ns10.example.com`. Unlike the
33395
+ other filters this one reads the nameservers of every domain in scope, so
33396
+ expect a slower response, the more so the larger the portfolio.
33397
+ in: query
33113
33398
  name: nameserver
33114
33399
  required: false
33115
33400
  schema:
33116
33401
  anyOf:
33117
33402
  - type: string
33118
33403
  - type: 'null'
33404
+ description: Filter domains whose nameserver hostnames contain this text,
33405
+ e.g. `cloudflare` or `ns1.example.com`. Matches the nameservers the domain
33406
+ currently delegates to. The text is matched literally, so `%` and `_`
33407
+ are not wildcards; a trailing dot on a single label anchors at a label
33408
+ boundary, so `ns1.` matches `ns1.example.com` but not `ns10.example.com`.
33409
+ Unlike the other filters this one reads the nameservers of every domain
33410
+ in scope, so expect a slower response, the more so the larger the portfolio.
33119
33411
  title: Nameserver
33120
- - in: query
33412
+ - description: Filter by transfer lock status
33413
+ in: query
33121
33414
  name: transfer_lock
33122
33415
  required: false
33123
33416
  schema:
33124
33417
  anyOf:
33125
33418
  - type: boolean
33126
33419
  - type: 'null'
33420
+ description: Filter by transfer lock status
33127
33421
  title: Transfer Lock
33128
- - in: query
33422
+ - description: Filter by read-only status
33423
+ in: query
33129
33424
  name: read_only
33130
33425
  required: false
33131
33426
  schema:
33132
33427
  anyOf:
33133
33428
  - type: boolean
33134
33429
  - type: 'null'
33430
+ description: Filter by read-only status
33135
33431
  title: Read Only
33136
- - in: query
33432
+ - description: Filter by premium domain status
33433
+ in: query
33137
33434
  name: is_premium
33138
33435
  required: false
33139
33436
  schema:
33140
33437
  anyOf:
33141
33438
  - type: boolean
33142
33439
  - type: 'null'
33440
+ description: Filter by premium domain status
33143
33441
  title: Is Premium
33144
- - in: query
33442
+ - description: Filter domains created after this date
33443
+ in: query
33145
33444
  name: created_after
33146
33445
  required: false
33147
33446
  schema:
@@ -33149,8 +33448,10 @@ paths:
33149
33448
  - format: date-time
33150
33449
  type: string
33151
33450
  - type: 'null'
33451
+ description: Filter domains created after this date
33152
33452
  title: Created After
33153
- - in: query
33453
+ - description: Filter domains created before this date
33454
+ in: query
33154
33455
  name: created_before
33155
33456
  required: false
33156
33457
  schema:
@@ -33158,8 +33459,10 @@ paths:
33158
33459
  - format: date-time
33159
33460
  type: string
33160
33461
  - type: 'null'
33462
+ description: Filter domains created before this date
33161
33463
  title: Created Before
33162
- - in: query
33464
+ - description: Filter domains updated after this date
33465
+ in: query
33163
33466
  name: updated_after
33164
33467
  required: false
33165
33468
  schema:
@@ -33167,8 +33470,10 @@ paths:
33167
33470
  - format: date-time
33168
33471
  type: string
33169
33472
  - type: 'null'
33473
+ description: Filter domains updated after this date
33170
33474
  title: Updated After
33171
- - in: query
33475
+ - description: Filter domains updated before this date
33476
+ in: query
33172
33477
  name: updated_before
33173
33478
  required: false
33174
33479
  schema:
@@ -33176,8 +33481,10 @@ paths:
33176
33481
  - format: date-time
33177
33482
  type: string
33178
33483
  - type: 'null'
33484
+ description: Filter domains updated before this date
33179
33485
  title: Updated Before
33180
- - in: query
33486
+ - description: Filter domains expiring after this date
33487
+ in: query
33181
33488
  name: expires_after
33182
33489
  required: false
33183
33490
  schema:
@@ -33185,8 +33492,10 @@ paths:
33185
33492
  - format: date-time
33186
33493
  type: string
33187
33494
  - type: 'null'
33495
+ description: Filter domains expiring after this date
33188
33496
  title: Expires After
33189
- - in: query
33497
+ - description: Filter domains expiring before this date
33498
+ in: query
33190
33499
  name: expires_before
33191
33500
  required: false
33192
33501
  schema:
@@ -33194,32 +33503,40 @@ paths:
33194
33503
  - format: date-time
33195
33504
  type: string
33196
33505
  - type: 'null'
33506
+ description: Filter domains expiring before this date
33197
33507
  title: Expires Before
33198
- - in: query
33508
+ - description: Filter domains expiring within the next 30 days
33509
+ in: query
33199
33510
  name: expires_in_30_days
33200
33511
  required: false
33201
33512
  schema:
33202
33513
  anyOf:
33203
33514
  - type: boolean
33204
33515
  - type: 'null'
33516
+ description: Filter domains expiring within the next 30 days
33205
33517
  title: Expires In 30 Days
33206
- - in: query
33518
+ - description: Filter domains expiring within the next 60 days
33519
+ in: query
33207
33520
  name: expires_in_60_days
33208
33521
  required: false
33209
33522
  schema:
33210
33523
  anyOf:
33211
33524
  - type: boolean
33212
33525
  - type: 'null'
33526
+ description: Filter domains expiring within the next 60 days
33213
33527
  title: Expires In 60 Days
33214
- - in: query
33528
+ - description: Filter domains expiring within the next 90 days
33529
+ in: query
33215
33530
  name: expires_in_90_days
33216
33531
  required: false
33217
33532
  schema:
33218
33533
  anyOf:
33219
33534
  - type: boolean
33220
33535
  - type: 'null'
33536
+ description: Filter domains expiring within the next 90 days
33221
33537
  title: Expires In 90 Days
33222
- - in: query
33538
+ - description: Filter domains registered after this date
33539
+ in: query
33223
33540
  name: registered_after
33224
33541
  required: false
33225
33542
  schema:
@@ -33227,8 +33544,10 @@ paths:
33227
33544
  - format: date-time
33228
33545
  type: string
33229
33546
  - type: 'null'
33547
+ description: Filter domains registered after this date
33230
33548
  title: Registered After
33231
- - in: query
33549
+ - description: Filter domains registered before this date
33550
+ in: query
33232
33551
  name: registered_before
33233
33552
  required: false
33234
33553
  schema:
@@ -33236,8 +33555,10 @@ paths:
33236
33555
  - format: date-time
33237
33556
  type: string
33238
33557
  - type: 'null'
33558
+ description: Filter domains registered before this date
33239
33559
  title: Registered Before
33240
- - in: query
33560
+ - description: Filter domains transferred in after this date
33561
+ in: query
33241
33562
  name: transferred_after
33242
33563
  required: false
33243
33564
  schema:
@@ -33245,8 +33566,10 @@ paths:
33245
33566
  - format: date-time
33246
33567
  type: string
33247
33568
  - type: 'null'
33569
+ description: Filter domains transferred in after this date
33248
33570
  title: Transferred After
33249
- - in: query
33571
+ - description: Filter domains transferred in before this date
33572
+ in: query
33250
33573
  name: transferred_before
33251
33574
  required: false
33252
33575
  schema:
@@ -33254,6 +33577,7 @@ paths:
33254
33577
  - format: date-time
33255
33578
  type: string
33256
33579
  - type: 'null'
33580
+ description: Filter domains transferred in before this date
33257
33581
  title: Transferred Before
33258
33582
  - description: Filter domains by registry status. Can be specified multiple
33259
33583
  times (union of all provided values).
@@ -33663,54 +33987,80 @@ paths:
33663
33987
  zero.'
33664
33988
  operationId: get_domain_statistics_v1_domains_statistics_get
33665
33989
  parameters:
33666
- - in: query
33990
+ - description: First day of the window, inclusive (YYYY-MM-DD, UTC)
33991
+ in: query
33667
33992
  name: start_date
33668
33993
  required: true
33669
33994
  schema:
33995
+ description: First day of the window, inclusive (YYYY-MM-DD, UTC)
33670
33996
  format: date
33671
33997
  title: Start Date
33672
33998
  type: string
33673
- - in: query
33999
+ - description: 'Last day of the window, inclusive (YYYY-MM-DD, UTC). How far
34000
+ it may reach depends on `granularity`: at most 92 days for `day`, 371 days
34001
+ for `week`, 396 days for `month`.'
34002
+ in: query
33674
34003
  name: end_date
33675
34004
  required: true
33676
34005
  schema:
34006
+ description: 'Last day of the window, inclusive (YYYY-MM-DD, UTC). How far
34007
+ it may reach depends on `granularity`: at most 92 days for `day`, 371
34008
+ days for `week`, 396 days for `month`.'
33677
34009
  format: date
33678
34010
  title: End Date
33679
34011
  type: string
33680
- - in: query
34012
+ - description: Time-bucket size. Weeks start on Monday and months on the 1st,
34013
+ in UTC.
34014
+ in: query
33681
34015
  name: granularity
33682
34016
  required: false
33683
34017
  schema:
33684
34018
  $ref: '#/components/schemas/UsageGranularity'
33685
34019
  default: day
33686
- - in: query
34020
+ description: Time-bucket size. Weeks start on Monday and months on the 1st,
34021
+ in UTC.
34022
+ - description: Restrict the counts to one top-level domain, e.g. `com`.
34023
+ in: query
33687
34024
  name: tld
33688
34025
  required: false
33689
34026
  schema:
33690
34027
  anyOf:
33691
34028
  - type: string
33692
34029
  - type: 'null'
34030
+ description: Restrict the counts to one top-level domain, e.g. `com`.
33693
34031
  title: Tld
33694
- - in: query
34032
+ - description: 'Adds a top-N list to the response: `organization` ranks your
34033
+ organization and its sub-organizations (so it needs `include_sub_organizations=true`),
34034
+ `tld` ranks the top-level domains.'
34035
+ in: query
33695
34036
  name: breakdown
33696
34037
  required: false
33697
34038
  schema:
33698
34039
  $ref: '#/components/schemas/DomainStatisticsBreakdown'
33699
34040
  default: none
33700
- - in: query
34041
+ description: 'Adds a top-N list to the response: `organization` ranks your
34042
+ organization and its sub-organizations (so it needs `include_sub_organizations=true`),
34043
+ `tld` ranks the top-level domains.'
34044
+ - description: How many rows the breakdown lists.
34045
+ in: query
33701
34046
  name: breakdown_limit
33702
34047
  required: false
33703
34048
  schema:
33704
34049
  default: 10
34050
+ description: How many rows the breakdown lists.
33705
34051
  maximum: 50
33706
34052
  minimum: 1
33707
34053
  title: Breakdown Limit
33708
34054
  type: integer
33709
- - in: query
34055
+ - description: Count your sub-organizations' domains too. By default only your
34056
+ own organization's domains are counted, as in the domain summary.
34057
+ in: query
33710
34058
  name: include_sub_organizations
33711
34059
  required: false
33712
34060
  schema:
33713
34061
  default: false
34062
+ description: Count your sub-organizations' domains too. By default only
34063
+ your own organization's domains are counted, as in the domain summary.
33714
34064
  title: Include Sub Organizations
33715
34065
  type: boolean
33716
34066
  - $ref: '#/components/parameters/DatetimeFormatHeader'
@@ -35740,34 +36090,42 @@ paths:
35740
36090
  minimum: 1
35741
36091
  title: Page Size
35742
36092
  type: integer
35743
- - in: query
36093
+ - description: Search by hostname
36094
+ in: query
35744
36095
  name: search
35745
36096
  required: false
35746
36097
  schema:
35747
36098
  anyOf:
35748
36099
  - type: string
35749
36100
  - type: 'null'
36101
+ description: Search by hostname
35750
36102
  title: Search
35751
- - in: query
36103
+ - description: Filter by enabled status
36104
+ in: query
35752
36105
  name: enabled
35753
36106
  required: false
35754
36107
  schema:
35755
36108
  anyOf:
35756
36109
  - type: boolean
35757
36110
  - type: 'null'
36111
+ description: Filter by enabled status
35758
36112
  title: Enabled
35759
- - in: query
36113
+ - description: Field to sort by
36114
+ in: query
35760
36115
  name: sort_by
35761
36116
  required: false
35762
36117
  schema:
35763
36118
  $ref: '#/components/schemas/EmailForwardSortField'
35764
36119
  default: created_on
35765
- - in: query
36120
+ description: Field to sort by
36121
+ - description: Sort order direction
36122
+ in: query
35766
36123
  name: sort_order
35767
36124
  required: false
35768
36125
  schema:
35769
36126
  $ref: '#/components/schemas/SortOrder'
35770
36127
  default: desc
36128
+ description: Sort order direction
35771
36129
  - $ref: '#/components/parameters/DatetimeFormatHeader'
35772
36130
  responses:
35773
36131
  '200':
@@ -36632,7 +36990,8 @@ paths:
36632
36990
  title: Email Forward Id
36633
36991
  type: string
36634
36992
  x-typeid-prefix: email_forward
36635
- - in: query
36993
+ - description: Filter metrics after (RFC3339)
36994
+ in: query
36636
36995
  name: start_time
36637
36996
  required: false
36638
36997
  schema:
@@ -36640,8 +36999,10 @@ paths:
36640
36999
  - format: date-time
36641
37000
  type: string
36642
37001
  - type: 'null'
37002
+ description: Filter metrics after (RFC3339)
36643
37003
  title: Start Time
36644
- - in: query
37004
+ - description: Filter metrics before (RFC3339)
37005
+ in: query
36645
37006
  name: end_time
36646
37007
  required: false
36647
37008
  schema:
@@ -36649,6 +37010,7 @@ paths:
36649
37010
  - format: date-time
36650
37011
  type: string
36651
37012
  - type: 'null'
37013
+ description: Filter metrics before (RFC3339)
36652
37014
  title: End Time
36653
37015
  - $ref: '#/components/parameters/DatetimeFormatHeader'
36654
37016
  responses:
@@ -36730,51 +37092,64 @@ paths:
36730
37092
  minimum: 1
36731
37093
  title: Page Size
36732
37094
  type: integer
36733
- - in: query
37095
+ - description: Field to sort by
37096
+ in: query
36734
37097
  name: sort_by
36735
37098
  required: false
36736
37099
  schema:
36737
37100
  $ref: '#/components/schemas/EventSortField'
36738
37101
  default: created_on
36739
- - in: query
37102
+ description: Field to sort by
37103
+ - description: Sort order direction
37104
+ in: query
36740
37105
  name: sort_order
36741
37106
  required: false
36742
37107
  schema:
36743
37108
  $ref: '#/components/schemas/SortOrder'
36744
37109
  default: desc
36745
- - in: query
37110
+ description: Sort order direction
37111
+ - description: Filter by
37112
+ in: query
36746
37113
  name: object_type
36747
37114
  required: false
36748
37115
  schema:
36749
37116
  anyOf:
36750
37117
  - $ref: '#/components/schemas/EventObjectType'
36751
37118
  - type: 'null'
37119
+ description: Filter by
36752
37120
  title: Object Type
36753
- - in: query
37121
+ - description: Filter by specific domain/contact/host name
37122
+ in: query
36754
37123
  name: object_id
36755
37124
  required: false
36756
37125
  schema:
36757
37126
  anyOf:
36758
37127
  - type: string
36759
37128
  - type: 'null'
37129
+ description: Filter by specific domain/contact/host name
36760
37130
  title: Object Id
36761
- - in: query
37131
+ - description: Filter by event type
37132
+ in: query
36762
37133
  name: type
36763
37134
  required: false
36764
37135
  schema:
36765
37136
  anyOf:
36766
37137
  - $ref: '#/components/schemas/EventType'
36767
37138
  - type: 'null'
37139
+ description: Filter by event type
36768
37140
  title: Type
36769
- - in: query
37141
+ - description: Filter by subtype
37142
+ in: query
36770
37143
  name: subtype
36771
37144
  required: false
36772
37145
  schema:
36773
37146
  anyOf:
36774
37147
  - $ref: '#/components/schemas/EventSubtype'
36775
37148
  - type: 'null'
37149
+ description: Filter by subtype
36776
37150
  title: Subtype
36777
- - in: query
37151
+ - description: Filter by acknowledgment status
37152
+ in: query
36778
37153
  name: acknowledged
36779
37154
  required: false
36780
37155
  schema:
@@ -36782,6 +37157,7 @@ paths:
36782
37157
  - type: boolean
36783
37158
  - type: 'null'
36784
37159
  default: false
37160
+ description: Filter by acknowledgment status
36785
37161
  title: Acknowledged
36786
37162
  - $ref: '#/components/parameters/DatetimeFormatHeader'
36787
37163
  responses:
@@ -38776,19 +39152,24 @@ paths:
38776
39152
  minimum: 1
38777
39153
  title: Page Size
38778
39154
  type: integer
38779
- - in: query
39155
+ - description: Field to sort by
39156
+ in: query
38780
39157
  name: sort_by
38781
39158
  required: false
38782
39159
  schema:
38783
39160
  $ref: '#/components/schemas/OrganizationSortField'
38784
39161
  default: created_on
38785
- - in: query
39162
+ description: Field to sort by
39163
+ - description: Sort order direction
39164
+ in: query
38786
39165
  name: sort_order
38787
39166
  required: false
38788
39167
  schema:
38789
39168
  $ref: '#/components/schemas/SortOrder'
38790
39169
  default: desc
38791
- - in: query
39170
+ description: Sort order direction
39171
+ - description: Search across organization name, address, and city
39172
+ in: query
38792
39173
  name: search
38793
39174
  required: false
38794
39175
  schema:
@@ -38796,8 +39177,10 @@ paths:
38796
39177
  - maxLength: 200
38797
39178
  type: string
38798
39179
  - type: 'null'
39180
+ description: Search across organization name, address, and city
38799
39181
  title: Search
38800
- - in: query
39182
+ - description: Filter by country code
39183
+ in: query
38801
39184
  name: country_code
38802
39185
  required: false
38803
39186
  schema:
@@ -38805,6 +39188,7 @@ paths:
38805
39188
  - pattern: ^\w{2}$
38806
39189
  type: string
38807
39190
  - type: 'null'
39191
+ description: Filter by country code
38808
39192
  title: Country Code
38809
39193
  - $ref: '#/components/parameters/DatetimeFormatHeader'
38810
39194
  responses:
@@ -39943,19 +40327,24 @@ paths:
39943
40327
  minimum: 1
39944
40328
  title: Page Size
39945
40329
  type: integer
39946
- - in: query
40330
+ - description: Field to sort by
40331
+ in: query
39947
40332
  name: sort_by
39948
40333
  required: false
39949
40334
  schema:
39950
40335
  $ref: '#/components/schemas/UserSortField'
39951
40336
  default: created_on
39952
- - in: query
40337
+ description: Field to sort by
40338
+ - description: Sort order direction
40339
+ in: query
39953
40340
  name: sort_order
39954
40341
  required: false
39955
40342
  schema:
39956
40343
  $ref: '#/components/schemas/SortOrder'
39957
40344
  default: desc
39958
- - in: query
40345
+ description: Sort order direction
40346
+ - description: Search across username, email, first name, and last name
40347
+ in: query
39959
40348
  name: search
39960
40349
  required: false
39961
40350
  schema:
@@ -39963,6 +40352,7 @@ paths:
39963
40352
  - maxLength: 200
39964
40353
  type: string
39965
40354
  - type: 'null'
40355
+ description: Search across username, email, first name, and last name
39966
40356
  title: Search
39967
40357
  - $ref: '#/components/parameters/DatetimeFormatHeader'
39968
40358
  responses:
@@ -40579,19 +40969,24 @@ paths:
40579
40969
  minimum: 1
40580
40970
  title: Page Size
40581
40971
  type: integer
40582
- - in: query
40972
+ - description: Field to sort by
40973
+ in: query
40583
40974
  name: sort_by
40584
40975
  required: false
40585
40976
  schema:
40586
40977
  $ref: '#/components/schemas/BillingTransactionSortField'
40587
40978
  default: created_on
40588
- - in: query
40979
+ description: Field to sort by
40980
+ - description: Sort order direction
40981
+ in: query
40589
40982
  name: sort_order
40590
40983
  required: false
40591
40984
  schema:
40592
40985
  $ref: '#/components/schemas/SortOrder'
40593
40986
  default: desc
40594
- - in: query
40987
+ description: Sort order direction
40988
+ - description: Filter by product reference
40989
+ in: query
40595
40990
  name: product_reference
40596
40991
  required: false
40597
40992
  schema:
@@ -40600,32 +40995,40 @@ paths:
40600
40995
  minLength: 1
40601
40996
  type: string
40602
40997
  - type: 'null'
40998
+ description: Filter by product reference
40603
40999
  title: Product Reference
40604
- - in: query
41000
+ - description: Filter by product type
41001
+ in: query
40605
41002
  name: product_type
40606
41003
  required: false
40607
41004
  schema:
40608
41005
  anyOf:
40609
41006
  - $ref: '#/components/schemas/BillingTransactionProductType'
40610
41007
  - type: 'null'
41008
+ description: Filter by product type
40611
41009
  title: Product Type
40612
- - in: query
41010
+ - description: Filter by action
41011
+ in: query
40613
41012
  name: action
40614
41013
  required: false
40615
41014
  schema:
40616
41015
  anyOf:
40617
41016
  - $ref: '#/components/schemas/BillingTransactionAction'
40618
41017
  - type: 'null'
41018
+ description: Filter by action
40619
41019
  title: Action
40620
- - in: query
41020
+ - description: Filter by status
41021
+ in: query
40621
41022
  name: status
40622
41023
  required: false
40623
41024
  schema:
40624
41025
  anyOf:
40625
41026
  - $ref: '#/components/schemas/BillingTransactionStatus'
40626
41027
  - type: 'null'
41028
+ description: Filter by status
40627
41029
  title: Status
40628
- - in: query
41030
+ - description: Filter by transactions created after this date
41031
+ in: query
40629
41032
  name: created_after
40630
41033
  required: false
40631
41034
  schema:
@@ -40633,8 +41036,10 @@ paths:
40633
41036
  - format: date-time
40634
41037
  type: string
40635
41038
  - type: 'null'
41039
+ description: Filter by transactions created after this date
40636
41040
  title: Created After
40637
- - in: query
41041
+ - description: Filter by transactions created before this date
41042
+ in: query
40638
41043
  name: created_before
40639
41044
  required: false
40640
41045
  schema:
@@ -40642,8 +41047,10 @@ paths:
40642
41047
  - format: date-time
40643
41048
  type: string
40644
41049
  - type: 'null'
41050
+ description: Filter by transactions created before this date
40645
41051
  title: Created Before
40646
- - in: query
41052
+ - description: Filter by transactions completed after this date
41053
+ in: query
40647
41054
  name: completed_after
40648
41055
  required: false
40649
41056
  schema:
@@ -40651,8 +41058,10 @@ paths:
40651
41058
  - format: date-time
40652
41059
  type: string
40653
41060
  - type: 'null'
41061
+ description: Filter by transactions completed after this date
40654
41062
  title: Completed After
40655
- - in: query
41063
+ - description: Filter by transactions completed before this date
41064
+ in: query
40656
41065
  name: completed_before
40657
41066
  required: false
40658
41067
  schema:
@@ -40660,6 +41069,7 @@ paths:
40660
41069
  - format: date-time
40661
41070
  type: string
40662
41071
  - type: 'null'
41072
+ description: Filter by transactions completed before this date
40663
41073
  title: Completed Before
40664
41074
  - $ref: '#/components/parameters/DatetimeFormatHeader'
40665
41075
  responses:
@@ -40989,41 +41399,51 @@ paths:
40989
41399
  minimum: 1
40990
41400
  title: Page Size
40991
41401
  type: integer
40992
- - in: query
41402
+ - description: Field to sort by
41403
+ in: query
40993
41404
  name: sort_by
40994
41405
  required: false
40995
41406
  schema:
40996
41407
  $ref: '#/components/schemas/ParkingSortField'
40997
41408
  default: created_on
40998
- - in: query
41409
+ description: Field to sort by
41410
+ - description: Sort order direction
41411
+ in: query
40999
41412
  name: sort_order
41000
41413
  required: false
41001
41414
  schema:
41002
41415
  $ref: '#/components/schemas/SortOrder'
41003
41416
  default: desc
41004
- - in: query
41417
+ description: Sort order direction
41418
+ - description: Search parking entries by domain name (contains)
41419
+ in: query
41005
41420
  name: search
41006
41421
  required: false
41007
41422
  schema:
41008
41423
  anyOf:
41009
41424
  - type: string
41010
41425
  - type: 'null'
41426
+ description: Search parking entries by domain name (contains)
41011
41427
  title: Search
41012
- - in: query
41428
+ - description: Filter by enabled status
41429
+ in: query
41013
41430
  name: enabled
41014
41431
  required: false
41015
41432
  schema:
41016
41433
  anyOf:
41017
41434
  - type: boolean
41018
41435
  - type: 'null'
41436
+ description: Filter by enabled status
41019
41437
  title: Enabled
41020
- - in: query
41438
+ - description: Filter by compliance status
41439
+ in: query
41021
41440
  name: compliance_status
41022
41441
  required: false
41023
41442
  schema:
41024
41443
  anyOf:
41025
41444
  - $ref: '#/components/schemas/ComplianceStatus'
41026
41445
  - type: 'null'
41446
+ description: Filter by compliance status
41027
41447
  title: Compliance Status
41028
41448
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41029
41449
  responses:
@@ -41076,7 +41496,8 @@ paths:
41076
41496
  description: Retrieves aggregated metrics for all parking entries of the organization.
41077
41497
  operationId: get_total_parking_metrics_v1_parking_metrics_get
41078
41498
  parameters:
41079
- - in: query
41499
+ - description: Filter metrics after (RFC3339)
41500
+ in: query
41080
41501
  name: start_time
41081
41502
  required: false
41082
41503
  schema:
@@ -41084,8 +41505,10 @@ paths:
41084
41505
  - format: date-time
41085
41506
  type: string
41086
41507
  - type: 'null'
41508
+ description: Filter metrics after (RFC3339)
41087
41509
  title: Start Time
41088
- - in: query
41510
+ - description: Filter metrics before (RFC3339)
41511
+ in: query
41089
41512
  name: end_time
41090
41513
  required: false
41091
41514
  schema:
@@ -41093,6 +41516,7 @@ paths:
41093
41516
  - format: date-time
41094
41517
  type: string
41095
41518
  - type: 'null'
41519
+ description: Filter metrics before (RFC3339)
41096
41520
  title: End Time
41097
41521
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41098
41522
  responses:
@@ -41267,7 +41691,8 @@ paths:
41267
41691
  x-typeid-prefix: parking
41268
41692
  - type: string
41269
41693
  title: Parking Reference
41270
- - in: query
41694
+ - description: Filter metrics after (RFC3339)
41695
+ in: query
41271
41696
  name: start_time
41272
41697
  required: false
41273
41698
  schema:
@@ -41275,8 +41700,10 @@ paths:
41275
41700
  - format: date-time
41276
41701
  type: string
41277
41702
  - type: 'null'
41703
+ description: Filter metrics after (RFC3339)
41278
41704
  title: Start Time
41279
- - in: query
41705
+ - description: Filter metrics before (RFC3339)
41706
+ in: query
41280
41707
  name: end_time
41281
41708
  required: false
41282
41709
  schema:
@@ -41284,6 +41711,7 @@ paths:
41284
41711
  - format: date-time
41285
41712
  type: string
41286
41713
  - type: 'null'
41714
+ description: Filter metrics before (RFC3339)
41287
41715
  title: End Time
41288
41716
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41289
41717
  responses:
@@ -41549,18 +41977,22 @@ paths:
41549
41977
  minimum: 1
41550
41978
  title: Page Size
41551
41979
  type: integer
41552
- - in: query
41980
+ - description: Field to sort by
41981
+ in: query
41553
41982
  name: sort_by
41554
41983
  required: false
41555
41984
  schema:
41556
41985
  $ref: '#/components/schemas/TagSortField'
41557
41986
  default: label
41558
- - in: query
41987
+ description: Field to sort by
41988
+ - description: Sort order direction
41989
+ in: query
41559
41990
  name: sort_order
41560
41991
  required: false
41561
41992
  schema:
41562
41993
  $ref: '#/components/schemas/SortOrder'
41563
41994
  default: asc
41995
+ description: Sort order direction
41564
41996
  - description: Filter by tag types (OR semantics)
41565
41997
  in: query
41566
41998
  name: tag_types
@@ -41573,13 +42005,15 @@ paths:
41573
42005
  - type: 'null'
41574
42006
  description: Filter by tag types (OR semantics)
41575
42007
  title: Tag Types
41576
- - in: query
42008
+ - description: Search tags by label (contains)
42009
+ in: query
41577
42010
  name: search
41578
42011
  required: false
41579
42012
  schema:
41580
42013
  anyOf:
41581
42014
  - type: string
41582
42015
  - type: 'null'
42016
+ description: Search tags by label (contains)
41583
42017
  title: Search
41584
42018
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41585
42019
  responses: