@opusdns/api 1.207.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
@@ -9327,7 +9327,7 @@ components:
9327
9327
  status_tags:
9328
9328
  anyOf:
9329
9329
  - items:
9330
- $ref: '#/components/schemas/StatusTagResponse'
9330
+ $ref: '#/components/schemas/ContactStatusTagResponse'
9331
9331
  type: array
9332
9332
  - type: 'null'
9333
9333
  description: Status tags assigned to this contact. Only included when ?include=tags
@@ -9375,6 +9375,37 @@ components:
9375
9375
  - created_on
9376
9376
  title: ContactSortField
9377
9377
  type: string
9378
+ ContactStatusTagResponse:
9379
+ properties:
9380
+ color:
9381
+ $ref: '#/components/schemas/TagColor'
9382
+ description: The color of the tag
9383
+ description:
9384
+ anyOf:
9385
+ - type: string
9386
+ - type: 'null'
9387
+ description: Additional information about this status tag
9388
+ title: Description
9389
+ label:
9390
+ description: The label of the tag
9391
+ maxLength: 255
9392
+ minLength: 1
9393
+ title: Label
9394
+ type: string
9395
+ tag_type:
9396
+ $ref: '#/components/schemas/ContactStatusTagType'
9397
+ description: The status tag type identifier
9398
+ required:
9399
+ - tag_type
9400
+ - label
9401
+ - color
9402
+ title: ContactStatusTagResponse
9403
+ type: object
9404
+ ContactStatusTagType:
9405
+ enum:
9406
+ - VERIFICATION_REQUIRED
9407
+ title: ContactStatusTagType
9408
+ type: string
9378
9409
  ContactType:
9379
9410
  enum:
9380
9411
  - owner
@@ -24969,7 +25000,7 @@ info:
24969
25000
  \n\n"
24970
25001
  summary: OpusDNS - your gateway to a seamless domain management experience.
24971
25002
  title: OpusDNS API
24972
- version: 2026-10-01-020708
25003
+ version: 2026-10-01-204618
24973
25004
  x-logo:
24974
25005
  altText: OpusDNS API Reference
24975
25006
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -26285,44 +26316,59 @@ paths:
26285
26316
  title: Email Forward Id
26286
26317
  type: string
26287
26318
  x-typeid-prefix: email_forward
26288
- - 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
26289
26322
  name: sort_by
26290
26323
  required: false
26291
26324
  schema:
26292
26325
  $ref: '#/components/schemas/EmailForwardLogSortField'
26293
26326
  default: created_on
26294
- - 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
26295
26331
  name: sort_order
26296
26332
  required: false
26297
26333
  schema:
26298
26334
  $ref: '#/components/schemas/SortOrder'
26299
26335
  default: desc
26300
- - in: query
26336
+ description: Sort order (asc, desc)
26337
+ - description: Records per page
26338
+ in: query
26301
26339
  name: page_size
26302
26340
  required: false
26303
26341
  schema:
26304
26342
  default: 50
26343
+ description: Records per page
26305
26344
  maximum: 1000
26306
26345
  minimum: 1
26307
26346
  title: Page Size
26308
26347
  type: integer
26309
- - in: query
26348
+ - description: Page number
26349
+ in: query
26310
26350
  name: page
26311
26351
  required: false
26312
26352
  schema:
26313
26353
  default: 1
26354
+ description: Page number
26314
26355
  minimum: 1
26315
26356
  title: Page
26316
26357
  type: integer
26317
- - in: query
26358
+ - description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26359
+ HARD-BOUNCE)
26360
+ in: query
26318
26361
  name: final_status
26319
26362
  required: false
26320
26363
  schema:
26321
26364
  anyOf:
26322
26365
  - $ref: '#/components/schemas/EmailForwardLogStatus'
26323
26366
  - type: 'null'
26367
+ description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26368
+ HARD-BOUNCE)
26324
26369
  title: Final Status
26325
- - in: query
26370
+ - description: Filter logs after (RFC3339)
26371
+ in: query
26326
26372
  name: start_time
26327
26373
  required: false
26328
26374
  schema:
@@ -26330,8 +26376,10 @@ paths:
26330
26376
  - format: date-time
26331
26377
  type: string
26332
26378
  - type: 'null'
26379
+ description: Filter logs after (RFC3339)
26333
26380
  title: Start Time
26334
- - in: query
26381
+ - description: Filter logs before (RFC3339)
26382
+ in: query
26335
26383
  name: end_time
26336
26384
  required: false
26337
26385
  schema:
@@ -26339,6 +26387,7 @@ paths:
26339
26387
  - format: date-time
26340
26388
  type: string
26341
26389
  - type: 'null'
26390
+ description: Filter logs before (RFC3339)
26342
26391
  title: End Time
26343
26392
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26344
26393
  responses:
@@ -26379,44 +26428,59 @@ paths:
26379
26428
  title: Email Forward Id
26380
26429
  type: string
26381
26430
  x-typeid-prefix: email_forward
26382
- - 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
26383
26434
  name: sort_by
26384
26435
  required: false
26385
26436
  schema:
26386
26437
  $ref: '#/components/schemas/EmailForwardLogSortField'
26387
26438
  default: created_on
26388
- - 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
26389
26443
  name: sort_order
26390
26444
  required: false
26391
26445
  schema:
26392
26446
  $ref: '#/components/schemas/SortOrder'
26393
26447
  default: desc
26394
- - in: query
26448
+ description: Sort order (asc, desc)
26449
+ - description: Records per page
26450
+ in: query
26395
26451
  name: page_size
26396
26452
  required: false
26397
26453
  schema:
26398
26454
  default: 50
26455
+ description: Records per page
26399
26456
  maximum: 1000
26400
26457
  minimum: 1
26401
26458
  title: Page Size
26402
26459
  type: integer
26403
- - in: query
26460
+ - description: Page number
26461
+ in: query
26404
26462
  name: page
26405
26463
  required: false
26406
26464
  schema:
26407
26465
  default: 1
26466
+ description: Page number
26408
26467
  minimum: 1
26409
26468
  title: Page
26410
26469
  type: integer
26411
- - in: query
26470
+ - description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26471
+ HARD-BOUNCE)
26472
+ in: query
26412
26473
  name: final_status
26413
26474
  required: false
26414
26475
  schema:
26415
26476
  anyOf:
26416
26477
  - $ref: '#/components/schemas/EmailForwardLogStatus'
26417
26478
  - type: 'null'
26479
+ description: Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
26480
+ HARD-BOUNCE)
26418
26481
  title: Final Status
26419
- - in: query
26482
+ - description: Filter logs after (RFC3339)
26483
+ in: query
26420
26484
  name: start_time
26421
26485
  required: false
26422
26486
  schema:
@@ -26424,8 +26488,10 @@ paths:
26424
26488
  - format: date-time
26425
26489
  type: string
26426
26490
  - type: 'null'
26491
+ description: Filter logs after (RFC3339)
26427
26492
  title: Start Time
26428
- - in: query
26493
+ - description: Filter logs before (RFC3339)
26494
+ in: query
26429
26495
  name: end_time
26430
26496
  required: false
26431
26497
  schema:
@@ -26433,6 +26499,7 @@ paths:
26433
26499
  - format: date-time
26434
26500
  type: string
26435
26501
  - type: 'null'
26502
+ description: Filter logs before (RFC3339)
26436
26503
  title: End Time
26437
26504
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26438
26505
  responses:
@@ -26461,84 +26528,107 @@ paths:
26461
26528
  description: Retrieve all paginated audit logs with optional filtering and sorting
26462
26529
  operationId: get_object_logs_v1_archive_object_logs_get
26463
26530
  parameters:
26464
- - 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
26465
26534
  name: sort_by
26466
26535
  required: false
26467
26536
  schema:
26468
26537
  $ref: '#/components/schemas/ObjectLogSortField'
26469
26538
  default: created_on
26470
- - 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
26471
26543
  name: sort_order
26472
26544
  required: false
26473
26545
  schema:
26474
26546
  $ref: '#/components/schemas/SortOrder'
26475
26547
  default: desc
26476
- - in: query
26548
+ description: Sort order (asc, desc)
26549
+ - description: Records per page
26550
+ in: query
26477
26551
  name: page_size
26478
26552
  required: false
26479
26553
  schema:
26480
26554
  default: 50
26555
+ description: Records per page
26481
26556
  maximum: 1000
26482
26557
  minimum: 1
26483
26558
  title: Page Size
26484
26559
  type: integer
26485
- - in: query
26560
+ - description: Page number
26561
+ in: query
26486
26562
  name: page
26487
26563
  required: false
26488
26564
  schema:
26489
26565
  default: 1
26566
+ description: Page number
26490
26567
  minimum: 1
26491
26568
  title: Page
26492
26569
  type: integer
26493
- - in: query
26570
+ - description: Filter by specific log UUID
26571
+ in: query
26494
26572
  name: object_log_id
26495
26573
  required: false
26496
26574
  schema:
26497
26575
  anyOf:
26498
26576
  - type: string
26499
26577
  - type: 'null'
26578
+ description: Filter by specific log UUID
26500
26579
  title: Object Log Id
26501
- - in: query
26580
+ - description: Filter by object type
26581
+ in: query
26502
26582
  name: object_type
26503
26583
  required: false
26504
26584
  schema:
26505
26585
  anyOf:
26506
26586
  - type: string
26507
26587
  - type: 'null'
26588
+ description: Filter by object type
26508
26589
  title: Object Type
26509
- - in: query
26590
+ - description: Filter by action
26591
+ in: query
26510
26592
  name: action
26511
26593
  required: false
26512
26594
  schema:
26513
26595
  anyOf:
26514
26596
  - $ref: '#/components/schemas/ObjectEventType'
26515
26597
  - type: 'null'
26598
+ description: Filter by action
26516
26599
  title: Action
26517
- - in: query
26600
+ - description: Filter by server request ID
26601
+ in: query
26518
26602
  name: server_request_id
26519
26603
  required: false
26520
26604
  schema:
26521
26605
  anyOf:
26522
26606
  - type: string
26523
26607
  - type: 'null'
26608
+ description: Filter by server request ID
26524
26609
  title: Server Request Id
26525
- - in: query
26610
+ - description: Filter by performer type
26611
+ in: query
26526
26612
  name: performed_by_type
26527
26613
  required: false
26528
26614
  schema:
26529
26615
  anyOf:
26530
26616
  - $ref: '#/components/schemas/ExecutingEntity'
26531
26617
  - type: 'null'
26618
+ description: Filter by performer type
26532
26619
  title: Performed By Type
26533
- - in: query
26620
+ - description: Filter by performer ID (TypeID)
26621
+ in: query
26534
26622
  name: performed_by_id
26535
26623
  required: false
26536
26624
  schema:
26537
26625
  anyOf:
26538
26626
  - type: string
26539
26627
  - type: 'null'
26628
+ description: Filter by performer ID (TypeID)
26540
26629
  title: Performed By Id
26541
- - in: query
26630
+ - description: 'Upper bound: created_on <= value (RFC3339)'
26631
+ in: query
26542
26632
  name: created_before
26543
26633
  required: false
26544
26634
  schema:
@@ -26546,8 +26636,10 @@ paths:
26546
26636
  - format: date-time
26547
26637
  type: string
26548
26638
  - type: 'null'
26639
+ description: 'Upper bound: created_on <= value (RFC3339)'
26549
26640
  title: Created Before
26550
- - in: query
26641
+ - description: 'Lower bound: created_on >= value (RFC3339)'
26642
+ in: query
26551
26643
  name: created_after
26552
26644
  required: false
26553
26645
  schema:
@@ -26555,14 +26647,17 @@ paths:
26555
26647
  - format: date-time
26556
26648
  type: string
26557
26649
  - type: 'null'
26650
+ description: 'Lower bound: created_on >= value (RFC3339)'
26558
26651
  title: Created After
26559
- - in: query
26652
+ - description: Filter by object ID (TypeID)
26653
+ in: query
26560
26654
  name: object_id
26561
26655
  required: false
26562
26656
  schema:
26563
26657
  anyOf:
26564
26658
  - type: string
26565
26659
  - type: 'null'
26660
+ description: Filter by object ID (TypeID)
26566
26661
  title: Object Id
26567
26662
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26568
26663
  responses:
@@ -26598,84 +26693,107 @@ paths:
26598
26693
  schema:
26599
26694
  title: Object Id
26600
26695
  type: string
26601
- - 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
26602
26699
  name: sort_by
26603
26700
  required: false
26604
26701
  schema:
26605
26702
  $ref: '#/components/schemas/ObjectLogSortField'
26606
26703
  default: created_on
26607
- - 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
26608
26708
  name: sort_order
26609
26709
  required: false
26610
26710
  schema:
26611
26711
  $ref: '#/components/schemas/SortOrder'
26612
26712
  default: desc
26613
- - in: query
26713
+ description: Sort order (asc, desc)
26714
+ - description: Records per page
26715
+ in: query
26614
26716
  name: page_size
26615
26717
  required: false
26616
26718
  schema:
26617
26719
  default: 50
26720
+ description: Records per page
26618
26721
  maximum: 1000
26619
26722
  minimum: 1
26620
26723
  title: Page Size
26621
26724
  type: integer
26622
- - in: query
26725
+ - description: Page number
26726
+ in: query
26623
26727
  name: page
26624
26728
  required: false
26625
26729
  schema:
26626
26730
  default: 1
26731
+ description: Page number
26627
26732
  minimum: 1
26628
26733
  title: Page
26629
26734
  type: integer
26630
- - in: query
26735
+ - description: Filter by specific log UUID
26736
+ in: query
26631
26737
  name: object_log_id
26632
26738
  required: false
26633
26739
  schema:
26634
26740
  anyOf:
26635
26741
  - type: string
26636
26742
  - type: 'null'
26743
+ description: Filter by specific log UUID
26637
26744
  title: Object Log Id
26638
- - in: query
26745
+ - description: Filter by object type
26746
+ in: query
26639
26747
  name: object_type
26640
26748
  required: false
26641
26749
  schema:
26642
26750
  anyOf:
26643
26751
  - type: string
26644
26752
  - type: 'null'
26753
+ description: Filter by object type
26645
26754
  title: Object Type
26646
- - in: query
26755
+ - description: Filter by action
26756
+ in: query
26647
26757
  name: action
26648
26758
  required: false
26649
26759
  schema:
26650
26760
  anyOf:
26651
26761
  - $ref: '#/components/schemas/ObjectEventType'
26652
26762
  - type: 'null'
26763
+ description: Filter by action
26653
26764
  title: Action
26654
- - in: query
26765
+ - description: Filter by server request ID
26766
+ in: query
26655
26767
  name: server_request_id
26656
26768
  required: false
26657
26769
  schema:
26658
26770
  anyOf:
26659
26771
  - type: string
26660
26772
  - type: 'null'
26773
+ description: Filter by server request ID
26661
26774
  title: Server Request Id
26662
- - in: query
26775
+ - description: Filter by performer type
26776
+ in: query
26663
26777
  name: performed_by_type
26664
26778
  required: false
26665
26779
  schema:
26666
26780
  anyOf:
26667
26781
  - $ref: '#/components/schemas/ExecutingEntity'
26668
26782
  - type: 'null'
26783
+ description: Filter by performer type
26669
26784
  title: Performed By Type
26670
- - in: query
26785
+ - description: Filter by performer ID (TypeID)
26786
+ in: query
26671
26787
  name: performed_by_id
26672
26788
  required: false
26673
26789
  schema:
26674
26790
  anyOf:
26675
26791
  - type: string
26676
26792
  - type: 'null'
26793
+ description: Filter by performer ID (TypeID)
26677
26794
  title: Performed By Id
26678
- - in: query
26795
+ - description: 'Upper bound: created_on <= value (RFC3339)'
26796
+ in: query
26679
26797
  name: created_before
26680
26798
  required: false
26681
26799
  schema:
@@ -26683,8 +26801,10 @@ paths:
26683
26801
  - format: date-time
26684
26802
  type: string
26685
26803
  - type: 'null'
26804
+ description: 'Upper bound: created_on <= value (RFC3339)'
26686
26805
  title: Created Before
26687
- - in: query
26806
+ - description: 'Lower bound: created_on >= value (RFC3339)'
26807
+ in: query
26688
26808
  name: created_after
26689
26809
  required: false
26690
26810
  schema:
@@ -26692,6 +26812,7 @@ paths:
26692
26812
  - format: date-time
26693
26813
  type: string
26694
26814
  - type: 'null'
26815
+ description: 'Lower bound: created_on >= value (RFC3339)'
26695
26816
  title: Created After
26696
26817
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26697
26818
  responses:
@@ -26720,18 +26841,26 @@ paths:
26720
26841
  description: Retrieves a paginated list of request history logs
26721
26842
  operationId: get_request_history_v1_archive_request_history_get
26722
26843
  parameters:
26723
- - 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
26724
26848
  name: sort_by
26725
26849
  required: false
26726
26850
  schema:
26727
26851
  $ref: '#/components/schemas/RequestHistorySortField'
26728
26852
  default: created_on
26729
- - 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
26730
26858
  name: sort_order
26731
26859
  required: false
26732
26860
  schema:
26733
26861
  $ref: '#/components/schemas/SortOrder'
26734
26862
  default: desc
26863
+ description: Sort order (asc, desc)
26735
26864
  - in: query
26736
26865
  name: page_size
26737
26866
  required: false
@@ -26749,63 +26878,78 @@ paths:
26749
26878
  minimum: 1
26750
26879
  title: Page
26751
26880
  type: integer
26752
- - in: query
26881
+ - description: HTTP method filter (GET, POST, etc.)
26882
+ in: query
26753
26883
  name: method
26754
26884
  required: false
26755
26885
  schema:
26756
26886
  anyOf:
26757
26887
  - $ref: '#/components/schemas/HTTPMethod'
26758
26888
  - type: 'null'
26889
+ description: HTTP method filter (GET, POST, etc.)
26759
26890
  title: Method
26760
- - in: query
26891
+ - description: Path filter (supports LIKE queries)
26892
+ in: query
26761
26893
  name: path
26762
26894
  required: false
26763
26895
  schema:
26764
26896
  anyOf:
26765
26897
  - type: string
26766
26898
  - type: 'null'
26899
+ description: Path filter (supports LIKE queries)
26767
26900
  title: Path
26768
- - in: query
26901
+ - description: Exact status code filter
26902
+ in: query
26769
26903
  name: status_code
26770
26904
  required: false
26771
26905
  schema:
26772
26906
  anyOf:
26773
26907
  - type: integer
26774
26908
  - type: 'null'
26909
+ description: Exact status code filter
26775
26910
  title: Status Code
26776
- - in: query
26911
+ - description: Minimum status code filter
26912
+ in: query
26777
26913
  name: min_status_code
26778
26914
  required: false
26779
26915
  schema:
26780
26916
  anyOf:
26781
26917
  - type: integer
26782
26918
  - type: 'null'
26919
+ description: Minimum status code filter
26783
26920
  title: Min Status Code
26784
- - in: query
26921
+ - description: Maximum status code filter
26922
+ in: query
26785
26923
  name: max_status_code
26786
26924
  required: false
26787
26925
  schema:
26788
26926
  anyOf:
26789
26927
  - type: integer
26790
26928
  - type: 'null'
26929
+ description: Maximum status code filter
26791
26930
  title: Max Status Code
26792
- - in: query
26931
+ - description: Minimum duration in milliseconds
26932
+ in: query
26793
26933
  name: min_duration
26794
26934
  required: false
26795
26935
  schema:
26796
26936
  anyOf:
26797
26937
  - type: number
26798
26938
  - type: 'null'
26939
+ description: Minimum duration in milliseconds
26799
26940
  title: Min Duration
26800
- - in: query
26941
+ - description: Maximum duration in milliseconds
26942
+ in: query
26801
26943
  name: max_duration
26802
26944
  required: false
26803
26945
  schema:
26804
26946
  anyOf:
26805
26947
  - type: number
26806
26948
  - type: 'null'
26949
+ description: Maximum duration in milliseconds
26807
26950
  title: Max Duration
26808
- - in: query
26951
+ - description: Client IP address filter
26952
+ in: query
26809
26953
  name: client_ip
26810
26954
  required: false
26811
26955
  schema:
@@ -26813,32 +26957,40 @@ paths:
26813
26957
  - format: ipvanyaddress
26814
26958
  type: string
26815
26959
  - type: 'null'
26960
+ description: Client IP address filter
26816
26961
  title: Client Ip
26817
- - in: query
26962
+ - description: Server request ID filter
26963
+ in: query
26818
26964
  name: server_request_id
26819
26965
  required: false
26820
26966
  schema:
26821
26967
  anyOf:
26822
26968
  - type: string
26823
26969
  - type: 'null'
26970
+ description: Server request ID filter
26824
26971
  title: Server Request Id
26825
- - in: query
26972
+ - description: Performed by type filter
26973
+ in: query
26826
26974
  name: performed_by_type
26827
26975
  required: false
26828
26976
  schema:
26829
26977
  anyOf:
26830
26978
  - $ref: '#/components/schemas/ExecutingEntity'
26831
26979
  - type: 'null'
26980
+ description: Performed by type filter
26832
26981
  title: Performed By Type
26833
- - in: query
26982
+ - description: Performed by ID filter
26983
+ in: query
26834
26984
  name: performed_by_id
26835
26985
  required: false
26836
26986
  schema:
26837
26987
  anyOf:
26838
26988
  - type: string
26839
26989
  - type: 'null'
26990
+ description: Performed by ID filter
26840
26991
  title: Performed By Id
26841
- - in: query
26992
+ - description: 'Upper bound: request_started_at <= value (RFC3339)'
26993
+ in: query
26842
26994
  name: request_started_before
26843
26995
  required: false
26844
26996
  schema:
@@ -26846,8 +26998,10 @@ paths:
26846
26998
  - format: date-time
26847
26999
  type: string
26848
27000
  - type: 'null'
27001
+ description: 'Upper bound: request_started_at <= value (RFC3339)'
26849
27002
  title: Request Started Before
26850
- - in: query
27003
+ - description: 'Lower bound: request_started_at >= value (RFC3339)'
27004
+ in: query
26851
27005
  name: request_started_after
26852
27006
  required: false
26853
27007
  schema:
@@ -26855,6 +27009,7 @@ paths:
26855
27009
  - format: date-time
26856
27010
  type: string
26857
27011
  - type: 'null'
27012
+ description: 'Lower bound: request_started_at >= value (RFC3339)'
26858
27013
  title: Request Started After
26859
27014
  - $ref: '#/components/parameters/DatetimeFormatHeader'
26860
27015
  responses:
@@ -27240,36 +27395,52 @@ paths:
27240
27395
  minimum: 1
27241
27396
  title: Page Size
27242
27397
  type: integer
27243
- - in: query
27398
+ - description: Field to sort by
27399
+ in: query
27244
27400
  name: sort_by
27245
27401
  required: false
27246
27402
  schema:
27247
27403
  $ref: '#/components/schemas/ContactSortField'
27248
27404
  default: created_on
27249
- - in: query
27405
+ description: Field to sort by
27406
+ - description: Sort order direction
27407
+ in: query
27250
27408
  name: sort_order
27251
27409
  required: false
27252
27410
  schema:
27253
27411
  $ref: '#/components/schemas/SortOrder'
27254
27412
  default: desc
27255
- - description: Filter by status tag types. Can be specified multiple times.
27413
+ description: Sort order direction
27414
+ - description: Filter by contact status tag types. Can be specified multiple
27415
+ times.
27256
27416
  in: query
27257
27417
  name: status_tags
27258
27418
  required: false
27259
27419
  schema:
27260
27420
  anyOf:
27261
27421
  - items:
27262
- $ref: '#/components/schemas/StatusTagType'
27422
+ $ref: '#/components/schemas/ContactStatusTagType'
27263
27423
  type: array
27264
27424
  - type: 'null'
27265
- description: Filter by status tag types. Can be specified multiple times.
27425
+ description: Filter by contact status tag types. Can be specified multiple
27426
+ times.
27266
27427
  title: Status Tags
27267
- - 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
27268
27434
  name: status_tag_mode
27269
27435
  required: false
27270
27436
  schema:
27271
27437
  $ref: '#/components/schemas/TagFilterMode'
27272
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.'
27273
27444
  - description: Filter by user tag IDs. Can be specified multiple times.
27274
27445
  in: query
27275
27446
  name: tag_ids
@@ -27287,69 +27458,106 @@ paths:
27287
27458
  - type: 'null'
27288
27459
  description: Filter by user tag IDs. Can be specified multiple times.
27289
27460
  title: Tag Ids
27290
- - 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
27291
27467
  name: tag_mode
27292
27468
  required: false
27293
27469
  schema:
27294
27470
  $ref: '#/components/schemas/TagFilterMode'
27295
27471
  default: match_any
27296
- - 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
27297
27481
  name: has_tags
27298
27482
  required: false
27299
27483
  schema:
27300
27484
  anyOf:
27301
27485
  - type: boolean
27302
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.
27303
27490
  title: Has Tags
27304
- - in: query
27491
+ - description: Filter by exact first name
27492
+ in: query
27305
27493
  name: first_name
27306
27494
  required: false
27307
27495
  schema:
27308
27496
  anyOf:
27309
27497
  - type: string
27310
27498
  - type: 'null'
27499
+ description: Filter by exact first name
27311
27500
  title: First Name
27312
- - in: query
27501
+ - description: Filter by exact last name
27502
+ in: query
27313
27503
  name: last_name
27314
27504
  required: false
27315
27505
  schema:
27316
27506
  anyOf:
27317
27507
  - type: string
27318
27508
  - type: 'null'
27509
+ description: Filter by exact last name
27319
27510
  title: Last Name
27320
- - in: query
27511
+ - description: Filter by exact email address
27512
+ in: query
27321
27513
  name: email
27322
27514
  required: false
27323
27515
  schema:
27324
27516
  anyOf:
27325
27517
  - type: string
27326
27518
  - type: 'null'
27519
+ description: Filter by exact email address
27327
27520
  title: Email
27328
- - 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
27329
27526
  name: search
27330
27527
  required: false
27331
27528
  schema:
27332
27529
  anyOf:
27333
27530
  - type: string
27334
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.
27335
27536
  title: Search
27336
- - in: query
27537
+ - description: Filter by country
27538
+ in: query
27337
27539
  name: country
27338
27540
  required: false
27339
27541
  schema:
27340
27542
  anyOf:
27341
27543
  - type: string
27342
27544
  - type: 'null'
27545
+ description: Filter by country
27343
27546
  title: Country
27344
- - in: query
27547
+ - description: Filter by whether the contact is in use by any domain (true =
27548
+ has domains, false = none)
27549
+ in: query
27345
27550
  name: in_use
27346
27551
  required: false
27347
27552
  schema:
27348
27553
  anyOf:
27349
27554
  - type: boolean
27350
27555
  - type: 'null'
27556
+ description: Filter by whether the contact is in use by any domain (true
27557
+ = has domains, false = none)
27351
27558
  title: In Use
27352
- - in: query
27559
+ - description: Filter contacts created after this date
27560
+ in: query
27353
27561
  name: created_after
27354
27562
  required: false
27355
27563
  schema:
@@ -27357,8 +27565,10 @@ paths:
27357
27565
  - format: date-time
27358
27566
  type: string
27359
27567
  - type: 'null'
27568
+ description: Filter contacts created after this date
27360
27569
  title: Created After
27361
- - in: query
27570
+ - description: Filter contacts created before this date
27571
+ in: query
27362
27572
  name: created_before
27363
27573
  required: false
27364
27574
  schema:
@@ -27366,6 +27576,7 @@ paths:
27366
27576
  - format: date-time
27367
27577
  type: string
27368
27578
  - type: 'null'
27579
+ description: Filter contacts created before this date
27369
27580
  title: Created Before
27370
27581
  - description: Include additional data in the response. Can be specified multiple
27371
27582
  times.
@@ -27478,33 +27689,41 @@ paths:
27478
27689
  minimum: 1
27479
27690
  title: Page Size
27480
27691
  type: integer
27481
- - in: query
27692
+ - description: Field to sort by
27693
+ in: query
27482
27694
  name: sort_by
27483
27695
  required: false
27484
27696
  schema:
27485
27697
  $ref: '#/components/schemas/ContactAttributeSetSortField'
27486
27698
  default: created_on
27487
- - in: query
27699
+ description: Field to sort by
27700
+ - description: Sort order direction
27701
+ in: query
27488
27702
  name: sort_order
27489
27703
  required: false
27490
27704
  schema:
27491
27705
  $ref: '#/components/schemas/SortOrder'
27492
27706
  default: desc
27493
- - in: query
27707
+ description: Sort order direction
27708
+ - description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
27709
+ in: query
27494
27710
  name: tld
27495
27711
  required: false
27496
27712
  schema:
27497
27713
  anyOf:
27498
27714
  - type: string
27499
27715
  - type: 'null'
27716
+ description: Filter by exact TLD (e.g. 'de', '.de', 'DE')
27500
27717
  title: Tld
27501
- - in: query
27718
+ - description: Filter by label (contains, case-insensitive)
27719
+ in: query
27502
27720
  name: label
27503
27721
  required: false
27504
27722
  schema:
27505
27723
  anyOf:
27506
27724
  - type: string
27507
27725
  - type: 'null'
27726
+ description: Filter by label (contains, case-insensitive)
27508
27727
  title: Label
27509
27728
  - $ref: '#/components/parameters/DatetimeFormatHeader'
27510
27729
  responses:
@@ -28589,18 +28808,22 @@ paths:
28589
28808
  minimum: 1
28590
28809
  title: Page Size
28591
28810
  type: integer
28592
- - in: query
28811
+ - description: Field to sort by
28812
+ in: query
28593
28813
  name: sort_by
28594
28814
  required: false
28595
28815
  schema:
28596
28816
  $ref: '#/components/schemas/ZoneSortField'
28597
28817
  default: created_on
28598
- - in: query
28818
+ description: Field to sort by
28819
+ - description: Sort order direction
28820
+ in: query
28599
28821
  name: sort_order
28600
28822
  required: false
28601
28823
  schema:
28602
28824
  $ref: '#/components/schemas/SortOrder'
28603
28825
  default: desc
28826
+ description: Sort order direction
28604
28827
  - description: Filter by user tag IDs. Can be specified multiple times.
28605
28828
  in: query
28606
28829
  name: tag_ids
@@ -28618,53 +28841,78 @@ paths:
28618
28841
  - type: 'null'
28619
28842
  description: Filter by user tag IDs. Can be specified multiple times.
28620
28843
  title: Tag Ids
28621
- - 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
28622
28850
  name: tag_mode
28623
28851
  required: false
28624
28852
  schema:
28625
28853
  $ref: '#/components/schemas/TagFilterMode'
28626
28854
  default: match_any
28627
- - 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
28628
28864
  name: has_tags
28629
28865
  required: false
28630
28866
  schema:
28631
28867
  anyOf:
28632
28868
  - type: boolean
28633
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.
28634
28873
  title: Has Tags
28635
- - in: query
28874
+ - description: Filter by DNSSEC status
28875
+ in: query
28636
28876
  name: dnssec_status
28637
28877
  required: false
28638
28878
  schema:
28639
28879
  anyOf:
28640
28880
  - $ref: '#/components/schemas/DnssecStatus'
28641
28881
  - type: 'null'
28882
+ description: Filter by DNSSEC status
28642
28883
  title: Dnssec Status
28643
- - in: query
28884
+ - description: Filter by exact zone name
28885
+ in: query
28644
28886
  name: name
28645
28887
  required: false
28646
28888
  schema:
28647
28889
  anyOf:
28648
28890
  - type: string
28649
28891
  - type: 'null'
28892
+ description: Filter by exact zone name
28650
28893
  title: Name
28651
- - in: query
28894
+ - description: Search zones by name (contains)
28895
+ in: query
28652
28896
  name: search
28653
28897
  required: false
28654
28898
  schema:
28655
28899
  anyOf:
28656
28900
  - type: string
28657
28901
  - type: 'null'
28902
+ description: Search zones by name (contains)
28658
28903
  title: Search
28659
- - in: query
28904
+ - description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
28905
+ in: query
28660
28906
  name: suffix
28661
28907
  required: false
28662
28908
  schema:
28663
28909
  anyOf:
28664
28910
  - type: string
28665
28911
  - type: 'null'
28912
+ description: Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk')
28666
28913
  title: Suffix
28667
- - in: query
28914
+ - description: Filter zones by the vanity nameserver set branding them
28915
+ in: query
28668
28916
  name: vanity_nameserver_set_id
28669
28917
  required: false
28670
28918
  schema:
@@ -28676,8 +28924,10 @@ paths:
28676
28924
  type: string
28677
28925
  x-typeid-prefix: vns
28678
28926
  - type: 'null'
28927
+ description: Filter zones by the vanity nameserver set branding them
28679
28928
  title: Vanity Nameserver Set Id
28680
- - in: query
28929
+ - description: Filter zones created after this date
28930
+ in: query
28681
28931
  name: created_after
28682
28932
  required: false
28683
28933
  schema:
@@ -28685,8 +28935,10 @@ paths:
28685
28935
  - format: date-time
28686
28936
  type: string
28687
28937
  - type: 'null'
28938
+ description: Filter zones created after this date
28688
28939
  title: Created After
28689
- - in: query
28940
+ - description: Filter zones created before this date
28941
+ in: query
28690
28942
  name: created_before
28691
28943
  required: false
28692
28944
  schema:
@@ -28694,8 +28946,10 @@ paths:
28694
28946
  - format: date-time
28695
28947
  type: string
28696
28948
  - type: 'null'
28949
+ description: Filter zones created before this date
28697
28950
  title: Created Before
28698
- - in: query
28951
+ - description: Filter zones updated after this date
28952
+ in: query
28699
28953
  name: updated_after
28700
28954
  required: false
28701
28955
  schema:
@@ -28703,8 +28957,10 @@ paths:
28703
28957
  - format: date-time
28704
28958
  type: string
28705
28959
  - type: 'null'
28960
+ description: Filter zones updated after this date
28706
28961
  title: Updated After
28707
- - in: query
28962
+ - description: Filter zones updated before this date
28963
+ in: query
28708
28964
  name: updated_before
28709
28965
  required: false
28710
28966
  schema:
@@ -28712,6 +28968,7 @@ paths:
28712
28968
  - format: date-time
28713
28969
  type: string
28714
28970
  - type: 'null'
28971
+ description: Filter zones updated before this date
28715
28972
  title: Updated Before
28716
28973
  - description: Include additional data in the response. Can be specified multiple
28717
28974
  times.
@@ -29100,26 +29357,32 @@ paths:
29100
29357
  minimum: 1
29101
29358
  title: Page Size
29102
29359
  type: integer
29103
- - in: query
29360
+ - description: Search by zone name
29361
+ in: query
29104
29362
  name: search
29105
29363
  required: false
29106
29364
  schema:
29107
29365
  anyOf:
29108
29366
  - type: string
29109
29367
  - type: 'null'
29368
+ description: Search by zone name
29110
29369
  title: Search
29111
- - in: query
29370
+ - description: Field to sort by
29371
+ in: query
29112
29372
  name: sort_by
29113
29373
  required: false
29114
29374
  schema:
29115
29375
  $ref: '#/components/schemas/DomainForwardZoneSortField'
29116
29376
  default: created_on
29117
- - in: query
29377
+ description: Field to sort by
29378
+ - description: Sort order direction
29379
+ in: query
29118
29380
  name: sort_order
29119
29381
  required: false
29120
29382
  schema:
29121
29383
  $ref: '#/components/schemas/SortOrder'
29122
29384
  default: desc
29385
+ description: Sort order direction
29123
29386
  - $ref: '#/components/parameters/DatetimeFormatHeader'
29124
29387
  responses:
29125
29388
  '200':
@@ -29222,26 +29485,32 @@ paths:
29222
29485
  minimum: 1
29223
29486
  title: Page Size
29224
29487
  type: integer
29225
- - in: query
29488
+ - description: Search by zone name
29489
+ in: query
29226
29490
  name: search
29227
29491
  required: false
29228
29492
  schema:
29229
29493
  anyOf:
29230
29494
  - type: string
29231
29495
  - type: 'null'
29496
+ description: Search by zone name
29232
29497
  title: Search
29233
- - in: query
29498
+ - description: Field to sort by
29499
+ in: query
29234
29500
  name: sort_by
29235
29501
  required: false
29236
29502
  schema:
29237
29503
  $ref: '#/components/schemas/EmailForwardZoneSortField'
29238
29504
  default: created_on
29239
- - in: query
29505
+ description: Field to sort by
29506
+ - description: Sort order direction
29507
+ in: query
29240
29508
  name: sort_order
29241
29509
  required: false
29242
29510
  schema:
29243
29511
  $ref: '#/components/schemas/SortOrder'
29244
29512
  default: desc
29513
+ description: Sort order direction
29245
29514
  - $ref: '#/components/parameters/DatetimeFormatHeader'
29246
29515
  responses:
29247
29516
  '200':
@@ -30348,26 +30617,32 @@ paths:
30348
30617
  minimum: 1
30349
30618
  title: Page Size
30350
30619
  type: integer
30351
- - in: query
30620
+ - description: Search by hostname
30621
+ in: query
30352
30622
  name: search
30353
30623
  required: false
30354
30624
  schema:
30355
30625
  anyOf:
30356
30626
  - type: string
30357
30627
  - type: 'null'
30628
+ description: Search by hostname
30358
30629
  title: Search
30359
- - in: query
30630
+ - description: Field to sort by
30631
+ in: query
30360
30632
  name: sort_by
30361
30633
  required: false
30362
30634
  schema:
30363
30635
  $ref: '#/components/schemas/DomainForwardSortField'
30364
30636
  default: created_on
30365
- - in: query
30637
+ description: Field to sort by
30638
+ - description: Sort order direction
30639
+ in: query
30366
30640
  name: sort_order
30367
30641
  required: false
30368
30642
  schema:
30369
30643
  $ref: '#/components/schemas/SortOrder'
30370
30644
  default: desc
30645
+ description: Sort order direction
30371
30646
  - $ref: '#/components/parameters/DatetimeFormatHeader'
30372
30647
  responses:
30373
30648
  '200':
@@ -32977,18 +33252,22 @@ paths:
32977
33252
  minimum: 1
32978
33253
  title: Page Size
32979
33254
  type: integer
32980
- - in: query
33255
+ - description: Field to sort by
33256
+ in: query
32981
33257
  name: sort_by
32982
33258
  required: false
32983
33259
  schema:
32984
33260
  $ref: '#/components/schemas/DomainSortField'
32985
33261
  default: created_on
32986
- - in: query
33262
+ description: Field to sort by
33263
+ - description: Sort order direction
33264
+ in: query
32987
33265
  name: sort_order
32988
33266
  required: false
32989
33267
  schema:
32990
33268
  $ref: '#/components/schemas/SortOrder'
32991
33269
  default: desc
33270
+ description: Sort order direction
32992
33271
  - description: Filter by status tag types. Can be specified multiple times.
32993
33272
  in: query
32994
33273
  name: status_tags
@@ -33001,12 +33280,22 @@ paths:
33001
33280
  - type: 'null'
33002
33281
  description: Filter by status tag types. Can be specified multiple times.
33003
33282
  title: Status Tags
33004
- - 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
33005
33289
  name: status_tag_mode
33006
33290
  required: false
33007
33291
  schema:
33008
33292
  $ref: '#/components/schemas/TagFilterMode'
33009
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.'
33010
33299
  - description: Filter by user tag IDs. Can be specified multiple times.
33011
33300
  in: query
33012
33301
  name: tag_ids
@@ -33024,35 +33313,55 @@ paths:
33024
33313
  - type: 'null'
33025
33314
  description: Filter by user tag IDs. Can be specified multiple times.
33026
33315
  title: Tag Ids
33027
- - 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
33028
33322
  name: tag_mode
33029
33323
  required: false
33030
33324
  schema:
33031
33325
  $ref: '#/components/schemas/TagFilterMode'
33032
33326
  default: match_any
33033
- - 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
33034
33336
  name: has_tags
33035
33337
  required: false
33036
33338
  schema:
33037
33339
  anyOf:
33038
33340
  - type: boolean
33039
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.
33040
33345
  title: Has Tags
33041
- - in: query
33346
+ - description: Filter by exact domain name
33347
+ in: query
33042
33348
  name: name
33043
33349
  required: false
33044
33350
  schema:
33045
33351
  anyOf:
33046
33352
  - type: string
33047
33353
  - type: 'null'
33354
+ description: Filter by exact domain name
33048
33355
  title: Name
33049
- - in: query
33356
+ - description: Search domains by name (contains) or domain ID (exact match)
33357
+ in: query
33050
33358
  name: search
33051
33359
  required: false
33052
33360
  schema:
33053
33361
  anyOf:
33054
33362
  - type: string
33055
33363
  - type: 'null'
33364
+ description: Search domains by name (contains) or domain ID (exact match)
33056
33365
  title: Search
33057
33366
  - description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
33058
33367
  multiple times (union of all provided values).
@@ -33068,47 +33377,70 @@ paths:
33068
33377
  description: Filter by top-level domain (e.g., 'com', 'org'). Can be specified
33069
33378
  multiple times (union of all provided values).
33070
33379
  title: Tld
33071
- - in: query
33380
+ - description: Filter by second-level domain
33381
+ in: query
33072
33382
  name: sld
33073
33383
  required: false
33074
33384
  schema:
33075
33385
  anyOf:
33076
33386
  - type: string
33077
33387
  - type: 'null'
33388
+ description: Filter by second-level domain
33078
33389
  title: Sld
33079
- - 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
33080
33398
  name: nameserver
33081
33399
  required: false
33082
33400
  schema:
33083
33401
  anyOf:
33084
33402
  - type: string
33085
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.
33086
33411
  title: Nameserver
33087
- - in: query
33412
+ - description: Filter by transfer lock status
33413
+ in: query
33088
33414
  name: transfer_lock
33089
33415
  required: false
33090
33416
  schema:
33091
33417
  anyOf:
33092
33418
  - type: boolean
33093
33419
  - type: 'null'
33420
+ description: Filter by transfer lock status
33094
33421
  title: Transfer Lock
33095
- - in: query
33422
+ - description: Filter by read-only status
33423
+ in: query
33096
33424
  name: read_only
33097
33425
  required: false
33098
33426
  schema:
33099
33427
  anyOf:
33100
33428
  - type: boolean
33101
33429
  - type: 'null'
33430
+ description: Filter by read-only status
33102
33431
  title: Read Only
33103
- - in: query
33432
+ - description: Filter by premium domain status
33433
+ in: query
33104
33434
  name: is_premium
33105
33435
  required: false
33106
33436
  schema:
33107
33437
  anyOf:
33108
33438
  - type: boolean
33109
33439
  - type: 'null'
33440
+ description: Filter by premium domain status
33110
33441
  title: Is Premium
33111
- - in: query
33442
+ - description: Filter domains created after this date
33443
+ in: query
33112
33444
  name: created_after
33113
33445
  required: false
33114
33446
  schema:
@@ -33116,8 +33448,10 @@ paths:
33116
33448
  - format: date-time
33117
33449
  type: string
33118
33450
  - type: 'null'
33451
+ description: Filter domains created after this date
33119
33452
  title: Created After
33120
- - in: query
33453
+ - description: Filter domains created before this date
33454
+ in: query
33121
33455
  name: created_before
33122
33456
  required: false
33123
33457
  schema:
@@ -33125,8 +33459,10 @@ paths:
33125
33459
  - format: date-time
33126
33460
  type: string
33127
33461
  - type: 'null'
33462
+ description: Filter domains created before this date
33128
33463
  title: Created Before
33129
- - in: query
33464
+ - description: Filter domains updated after this date
33465
+ in: query
33130
33466
  name: updated_after
33131
33467
  required: false
33132
33468
  schema:
@@ -33134,8 +33470,10 @@ paths:
33134
33470
  - format: date-time
33135
33471
  type: string
33136
33472
  - type: 'null'
33473
+ description: Filter domains updated after this date
33137
33474
  title: Updated After
33138
- - in: query
33475
+ - description: Filter domains updated before this date
33476
+ in: query
33139
33477
  name: updated_before
33140
33478
  required: false
33141
33479
  schema:
@@ -33143,8 +33481,10 @@ paths:
33143
33481
  - format: date-time
33144
33482
  type: string
33145
33483
  - type: 'null'
33484
+ description: Filter domains updated before this date
33146
33485
  title: Updated Before
33147
- - in: query
33486
+ - description: Filter domains expiring after this date
33487
+ in: query
33148
33488
  name: expires_after
33149
33489
  required: false
33150
33490
  schema:
@@ -33152,8 +33492,10 @@ paths:
33152
33492
  - format: date-time
33153
33493
  type: string
33154
33494
  - type: 'null'
33495
+ description: Filter domains expiring after this date
33155
33496
  title: Expires After
33156
- - in: query
33497
+ - description: Filter domains expiring before this date
33498
+ in: query
33157
33499
  name: expires_before
33158
33500
  required: false
33159
33501
  schema:
@@ -33161,32 +33503,40 @@ paths:
33161
33503
  - format: date-time
33162
33504
  type: string
33163
33505
  - type: 'null'
33506
+ description: Filter domains expiring before this date
33164
33507
  title: Expires Before
33165
- - in: query
33508
+ - description: Filter domains expiring within the next 30 days
33509
+ in: query
33166
33510
  name: expires_in_30_days
33167
33511
  required: false
33168
33512
  schema:
33169
33513
  anyOf:
33170
33514
  - type: boolean
33171
33515
  - type: 'null'
33516
+ description: Filter domains expiring within the next 30 days
33172
33517
  title: Expires In 30 Days
33173
- - in: query
33518
+ - description: Filter domains expiring within the next 60 days
33519
+ in: query
33174
33520
  name: expires_in_60_days
33175
33521
  required: false
33176
33522
  schema:
33177
33523
  anyOf:
33178
33524
  - type: boolean
33179
33525
  - type: 'null'
33526
+ description: Filter domains expiring within the next 60 days
33180
33527
  title: Expires In 60 Days
33181
- - in: query
33528
+ - description: Filter domains expiring within the next 90 days
33529
+ in: query
33182
33530
  name: expires_in_90_days
33183
33531
  required: false
33184
33532
  schema:
33185
33533
  anyOf:
33186
33534
  - type: boolean
33187
33535
  - type: 'null'
33536
+ description: Filter domains expiring within the next 90 days
33188
33537
  title: Expires In 90 Days
33189
- - in: query
33538
+ - description: Filter domains registered after this date
33539
+ in: query
33190
33540
  name: registered_after
33191
33541
  required: false
33192
33542
  schema:
@@ -33194,8 +33544,10 @@ paths:
33194
33544
  - format: date-time
33195
33545
  type: string
33196
33546
  - type: 'null'
33547
+ description: Filter domains registered after this date
33197
33548
  title: Registered After
33198
- - in: query
33549
+ - description: Filter domains registered before this date
33550
+ in: query
33199
33551
  name: registered_before
33200
33552
  required: false
33201
33553
  schema:
@@ -33203,8 +33555,10 @@ paths:
33203
33555
  - format: date-time
33204
33556
  type: string
33205
33557
  - type: 'null'
33558
+ description: Filter domains registered before this date
33206
33559
  title: Registered Before
33207
- - in: query
33560
+ - description: Filter domains transferred in after this date
33561
+ in: query
33208
33562
  name: transferred_after
33209
33563
  required: false
33210
33564
  schema:
@@ -33212,8 +33566,10 @@ paths:
33212
33566
  - format: date-time
33213
33567
  type: string
33214
33568
  - type: 'null'
33569
+ description: Filter domains transferred in after this date
33215
33570
  title: Transferred After
33216
- - in: query
33571
+ - description: Filter domains transferred in before this date
33572
+ in: query
33217
33573
  name: transferred_before
33218
33574
  required: false
33219
33575
  schema:
@@ -33221,6 +33577,7 @@ paths:
33221
33577
  - format: date-time
33222
33578
  type: string
33223
33579
  - type: 'null'
33580
+ description: Filter domains transferred in before this date
33224
33581
  title: Transferred Before
33225
33582
  - description: Filter domains by registry status. Can be specified multiple
33226
33583
  times (union of all provided values).
@@ -33630,54 +33987,80 @@ paths:
33630
33987
  zero.'
33631
33988
  operationId: get_domain_statistics_v1_domains_statistics_get
33632
33989
  parameters:
33633
- - in: query
33990
+ - description: First day of the window, inclusive (YYYY-MM-DD, UTC)
33991
+ in: query
33634
33992
  name: start_date
33635
33993
  required: true
33636
33994
  schema:
33995
+ description: First day of the window, inclusive (YYYY-MM-DD, UTC)
33637
33996
  format: date
33638
33997
  title: Start Date
33639
33998
  type: string
33640
- - 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
33641
34003
  name: end_date
33642
34004
  required: true
33643
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`.'
33644
34009
  format: date
33645
34010
  title: End Date
33646
34011
  type: string
33647
- - in: query
34012
+ - description: Time-bucket size. Weeks start on Monday and months on the 1st,
34013
+ in UTC.
34014
+ in: query
33648
34015
  name: granularity
33649
34016
  required: false
33650
34017
  schema:
33651
34018
  $ref: '#/components/schemas/UsageGranularity'
33652
34019
  default: day
33653
- - 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
33654
34024
  name: tld
33655
34025
  required: false
33656
34026
  schema:
33657
34027
  anyOf:
33658
34028
  - type: string
33659
34029
  - type: 'null'
34030
+ description: Restrict the counts to one top-level domain, e.g. `com`.
33660
34031
  title: Tld
33661
- - 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
33662
34036
  name: breakdown
33663
34037
  required: false
33664
34038
  schema:
33665
34039
  $ref: '#/components/schemas/DomainStatisticsBreakdown'
33666
34040
  default: none
33667
- - 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
33668
34046
  name: breakdown_limit
33669
34047
  required: false
33670
34048
  schema:
33671
34049
  default: 10
34050
+ description: How many rows the breakdown lists.
33672
34051
  maximum: 50
33673
34052
  minimum: 1
33674
34053
  title: Breakdown Limit
33675
34054
  type: integer
33676
- - 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
33677
34058
  name: include_sub_organizations
33678
34059
  required: false
33679
34060
  schema:
33680
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.
33681
34064
  title: Include Sub Organizations
33682
34065
  type: boolean
33683
34066
  - $ref: '#/components/parameters/DatetimeFormatHeader'
@@ -35707,34 +36090,42 @@ paths:
35707
36090
  minimum: 1
35708
36091
  title: Page Size
35709
36092
  type: integer
35710
- - in: query
36093
+ - description: Search by hostname
36094
+ in: query
35711
36095
  name: search
35712
36096
  required: false
35713
36097
  schema:
35714
36098
  anyOf:
35715
36099
  - type: string
35716
36100
  - type: 'null'
36101
+ description: Search by hostname
35717
36102
  title: Search
35718
- - in: query
36103
+ - description: Filter by enabled status
36104
+ in: query
35719
36105
  name: enabled
35720
36106
  required: false
35721
36107
  schema:
35722
36108
  anyOf:
35723
36109
  - type: boolean
35724
36110
  - type: 'null'
36111
+ description: Filter by enabled status
35725
36112
  title: Enabled
35726
- - in: query
36113
+ - description: Field to sort by
36114
+ in: query
35727
36115
  name: sort_by
35728
36116
  required: false
35729
36117
  schema:
35730
36118
  $ref: '#/components/schemas/EmailForwardSortField'
35731
36119
  default: created_on
35732
- - in: query
36120
+ description: Field to sort by
36121
+ - description: Sort order direction
36122
+ in: query
35733
36123
  name: sort_order
35734
36124
  required: false
35735
36125
  schema:
35736
36126
  $ref: '#/components/schemas/SortOrder'
35737
36127
  default: desc
36128
+ description: Sort order direction
35738
36129
  - $ref: '#/components/parameters/DatetimeFormatHeader'
35739
36130
  responses:
35740
36131
  '200':
@@ -36599,7 +36990,8 @@ paths:
36599
36990
  title: Email Forward Id
36600
36991
  type: string
36601
36992
  x-typeid-prefix: email_forward
36602
- - in: query
36993
+ - description: Filter metrics after (RFC3339)
36994
+ in: query
36603
36995
  name: start_time
36604
36996
  required: false
36605
36997
  schema:
@@ -36607,8 +36999,10 @@ paths:
36607
36999
  - format: date-time
36608
37000
  type: string
36609
37001
  - type: 'null'
37002
+ description: Filter metrics after (RFC3339)
36610
37003
  title: Start Time
36611
- - in: query
37004
+ - description: Filter metrics before (RFC3339)
37005
+ in: query
36612
37006
  name: end_time
36613
37007
  required: false
36614
37008
  schema:
@@ -36616,6 +37010,7 @@ paths:
36616
37010
  - format: date-time
36617
37011
  type: string
36618
37012
  - type: 'null'
37013
+ description: Filter metrics before (RFC3339)
36619
37014
  title: End Time
36620
37015
  - $ref: '#/components/parameters/DatetimeFormatHeader'
36621
37016
  responses:
@@ -36697,51 +37092,64 @@ paths:
36697
37092
  minimum: 1
36698
37093
  title: Page Size
36699
37094
  type: integer
36700
- - in: query
37095
+ - description: Field to sort by
37096
+ in: query
36701
37097
  name: sort_by
36702
37098
  required: false
36703
37099
  schema:
36704
37100
  $ref: '#/components/schemas/EventSortField'
36705
37101
  default: created_on
36706
- - in: query
37102
+ description: Field to sort by
37103
+ - description: Sort order direction
37104
+ in: query
36707
37105
  name: sort_order
36708
37106
  required: false
36709
37107
  schema:
36710
37108
  $ref: '#/components/schemas/SortOrder'
36711
37109
  default: desc
36712
- - in: query
37110
+ description: Sort order direction
37111
+ - description: Filter by
37112
+ in: query
36713
37113
  name: object_type
36714
37114
  required: false
36715
37115
  schema:
36716
37116
  anyOf:
36717
37117
  - $ref: '#/components/schemas/EventObjectType'
36718
37118
  - type: 'null'
37119
+ description: Filter by
36719
37120
  title: Object Type
36720
- - in: query
37121
+ - description: Filter by specific domain/contact/host name
37122
+ in: query
36721
37123
  name: object_id
36722
37124
  required: false
36723
37125
  schema:
36724
37126
  anyOf:
36725
37127
  - type: string
36726
37128
  - type: 'null'
37129
+ description: Filter by specific domain/contact/host name
36727
37130
  title: Object Id
36728
- - in: query
37131
+ - description: Filter by event type
37132
+ in: query
36729
37133
  name: type
36730
37134
  required: false
36731
37135
  schema:
36732
37136
  anyOf:
36733
37137
  - $ref: '#/components/schemas/EventType'
36734
37138
  - type: 'null'
37139
+ description: Filter by event type
36735
37140
  title: Type
36736
- - in: query
37141
+ - description: Filter by subtype
37142
+ in: query
36737
37143
  name: subtype
36738
37144
  required: false
36739
37145
  schema:
36740
37146
  anyOf:
36741
37147
  - $ref: '#/components/schemas/EventSubtype'
36742
37148
  - type: 'null'
37149
+ description: Filter by subtype
36743
37150
  title: Subtype
36744
- - in: query
37151
+ - description: Filter by acknowledgment status
37152
+ in: query
36745
37153
  name: acknowledged
36746
37154
  required: false
36747
37155
  schema:
@@ -36749,6 +37157,7 @@ paths:
36749
37157
  - type: boolean
36750
37158
  - type: 'null'
36751
37159
  default: false
37160
+ description: Filter by acknowledgment status
36752
37161
  title: Acknowledged
36753
37162
  - $ref: '#/components/parameters/DatetimeFormatHeader'
36754
37163
  responses:
@@ -38743,19 +39152,24 @@ paths:
38743
39152
  minimum: 1
38744
39153
  title: Page Size
38745
39154
  type: integer
38746
- - in: query
39155
+ - description: Field to sort by
39156
+ in: query
38747
39157
  name: sort_by
38748
39158
  required: false
38749
39159
  schema:
38750
39160
  $ref: '#/components/schemas/OrganizationSortField'
38751
39161
  default: created_on
38752
- - in: query
39162
+ description: Field to sort by
39163
+ - description: Sort order direction
39164
+ in: query
38753
39165
  name: sort_order
38754
39166
  required: false
38755
39167
  schema:
38756
39168
  $ref: '#/components/schemas/SortOrder'
38757
39169
  default: desc
38758
- - in: query
39170
+ description: Sort order direction
39171
+ - description: Search across organization name, address, and city
39172
+ in: query
38759
39173
  name: search
38760
39174
  required: false
38761
39175
  schema:
@@ -38763,8 +39177,10 @@ paths:
38763
39177
  - maxLength: 200
38764
39178
  type: string
38765
39179
  - type: 'null'
39180
+ description: Search across organization name, address, and city
38766
39181
  title: Search
38767
- - in: query
39182
+ - description: Filter by country code
39183
+ in: query
38768
39184
  name: country_code
38769
39185
  required: false
38770
39186
  schema:
@@ -38772,6 +39188,7 @@ paths:
38772
39188
  - pattern: ^\w{2}$
38773
39189
  type: string
38774
39190
  - type: 'null'
39191
+ description: Filter by country code
38775
39192
  title: Country Code
38776
39193
  - $ref: '#/components/parameters/DatetimeFormatHeader'
38777
39194
  responses:
@@ -39910,19 +40327,24 @@ paths:
39910
40327
  minimum: 1
39911
40328
  title: Page Size
39912
40329
  type: integer
39913
- - in: query
40330
+ - description: Field to sort by
40331
+ in: query
39914
40332
  name: sort_by
39915
40333
  required: false
39916
40334
  schema:
39917
40335
  $ref: '#/components/schemas/UserSortField'
39918
40336
  default: created_on
39919
- - in: query
40337
+ description: Field to sort by
40338
+ - description: Sort order direction
40339
+ in: query
39920
40340
  name: sort_order
39921
40341
  required: false
39922
40342
  schema:
39923
40343
  $ref: '#/components/schemas/SortOrder'
39924
40344
  default: desc
39925
- - in: query
40345
+ description: Sort order direction
40346
+ - description: Search across username, email, first name, and last name
40347
+ in: query
39926
40348
  name: search
39927
40349
  required: false
39928
40350
  schema:
@@ -39930,6 +40352,7 @@ paths:
39930
40352
  - maxLength: 200
39931
40353
  type: string
39932
40354
  - type: 'null'
40355
+ description: Search across username, email, first name, and last name
39933
40356
  title: Search
39934
40357
  - $ref: '#/components/parameters/DatetimeFormatHeader'
39935
40358
  responses:
@@ -40546,19 +40969,24 @@ paths:
40546
40969
  minimum: 1
40547
40970
  title: Page Size
40548
40971
  type: integer
40549
- - in: query
40972
+ - description: Field to sort by
40973
+ in: query
40550
40974
  name: sort_by
40551
40975
  required: false
40552
40976
  schema:
40553
40977
  $ref: '#/components/schemas/BillingTransactionSortField'
40554
40978
  default: created_on
40555
- - in: query
40979
+ description: Field to sort by
40980
+ - description: Sort order direction
40981
+ in: query
40556
40982
  name: sort_order
40557
40983
  required: false
40558
40984
  schema:
40559
40985
  $ref: '#/components/schemas/SortOrder'
40560
40986
  default: desc
40561
- - in: query
40987
+ description: Sort order direction
40988
+ - description: Filter by product reference
40989
+ in: query
40562
40990
  name: product_reference
40563
40991
  required: false
40564
40992
  schema:
@@ -40567,32 +40995,40 @@ paths:
40567
40995
  minLength: 1
40568
40996
  type: string
40569
40997
  - type: 'null'
40998
+ description: Filter by product reference
40570
40999
  title: Product Reference
40571
- - in: query
41000
+ - description: Filter by product type
41001
+ in: query
40572
41002
  name: product_type
40573
41003
  required: false
40574
41004
  schema:
40575
41005
  anyOf:
40576
41006
  - $ref: '#/components/schemas/BillingTransactionProductType'
40577
41007
  - type: 'null'
41008
+ description: Filter by product type
40578
41009
  title: Product Type
40579
- - in: query
41010
+ - description: Filter by action
41011
+ in: query
40580
41012
  name: action
40581
41013
  required: false
40582
41014
  schema:
40583
41015
  anyOf:
40584
41016
  - $ref: '#/components/schemas/BillingTransactionAction'
40585
41017
  - type: 'null'
41018
+ description: Filter by action
40586
41019
  title: Action
40587
- - in: query
41020
+ - description: Filter by status
41021
+ in: query
40588
41022
  name: status
40589
41023
  required: false
40590
41024
  schema:
40591
41025
  anyOf:
40592
41026
  - $ref: '#/components/schemas/BillingTransactionStatus'
40593
41027
  - type: 'null'
41028
+ description: Filter by status
40594
41029
  title: Status
40595
- - in: query
41030
+ - description: Filter by transactions created after this date
41031
+ in: query
40596
41032
  name: created_after
40597
41033
  required: false
40598
41034
  schema:
@@ -40600,8 +41036,10 @@ paths:
40600
41036
  - format: date-time
40601
41037
  type: string
40602
41038
  - type: 'null'
41039
+ description: Filter by transactions created after this date
40603
41040
  title: Created After
40604
- - in: query
41041
+ - description: Filter by transactions created before this date
41042
+ in: query
40605
41043
  name: created_before
40606
41044
  required: false
40607
41045
  schema:
@@ -40609,8 +41047,10 @@ paths:
40609
41047
  - format: date-time
40610
41048
  type: string
40611
41049
  - type: 'null'
41050
+ description: Filter by transactions created before this date
40612
41051
  title: Created Before
40613
- - in: query
41052
+ - description: Filter by transactions completed after this date
41053
+ in: query
40614
41054
  name: completed_after
40615
41055
  required: false
40616
41056
  schema:
@@ -40618,8 +41058,10 @@ paths:
40618
41058
  - format: date-time
40619
41059
  type: string
40620
41060
  - type: 'null'
41061
+ description: Filter by transactions completed after this date
40621
41062
  title: Completed After
40622
- - in: query
41063
+ - description: Filter by transactions completed before this date
41064
+ in: query
40623
41065
  name: completed_before
40624
41066
  required: false
40625
41067
  schema:
@@ -40627,6 +41069,7 @@ paths:
40627
41069
  - format: date-time
40628
41070
  type: string
40629
41071
  - type: 'null'
41072
+ description: Filter by transactions completed before this date
40630
41073
  title: Completed Before
40631
41074
  - $ref: '#/components/parameters/DatetimeFormatHeader'
40632
41075
  responses:
@@ -40956,41 +41399,51 @@ paths:
40956
41399
  minimum: 1
40957
41400
  title: Page Size
40958
41401
  type: integer
40959
- - in: query
41402
+ - description: Field to sort by
41403
+ in: query
40960
41404
  name: sort_by
40961
41405
  required: false
40962
41406
  schema:
40963
41407
  $ref: '#/components/schemas/ParkingSortField'
40964
41408
  default: created_on
40965
- - in: query
41409
+ description: Field to sort by
41410
+ - description: Sort order direction
41411
+ in: query
40966
41412
  name: sort_order
40967
41413
  required: false
40968
41414
  schema:
40969
41415
  $ref: '#/components/schemas/SortOrder'
40970
41416
  default: desc
40971
- - in: query
41417
+ description: Sort order direction
41418
+ - description: Search parking entries by domain name (contains)
41419
+ in: query
40972
41420
  name: search
40973
41421
  required: false
40974
41422
  schema:
40975
41423
  anyOf:
40976
41424
  - type: string
40977
41425
  - type: 'null'
41426
+ description: Search parking entries by domain name (contains)
40978
41427
  title: Search
40979
- - in: query
41428
+ - description: Filter by enabled status
41429
+ in: query
40980
41430
  name: enabled
40981
41431
  required: false
40982
41432
  schema:
40983
41433
  anyOf:
40984
41434
  - type: boolean
40985
41435
  - type: 'null'
41436
+ description: Filter by enabled status
40986
41437
  title: Enabled
40987
- - in: query
41438
+ - description: Filter by compliance status
41439
+ in: query
40988
41440
  name: compliance_status
40989
41441
  required: false
40990
41442
  schema:
40991
41443
  anyOf:
40992
41444
  - $ref: '#/components/schemas/ComplianceStatus'
40993
41445
  - type: 'null'
41446
+ description: Filter by compliance status
40994
41447
  title: Compliance Status
40995
41448
  - $ref: '#/components/parameters/DatetimeFormatHeader'
40996
41449
  responses:
@@ -41043,7 +41496,8 @@ paths:
41043
41496
  description: Retrieves aggregated metrics for all parking entries of the organization.
41044
41497
  operationId: get_total_parking_metrics_v1_parking_metrics_get
41045
41498
  parameters:
41046
- - in: query
41499
+ - description: Filter metrics after (RFC3339)
41500
+ in: query
41047
41501
  name: start_time
41048
41502
  required: false
41049
41503
  schema:
@@ -41051,8 +41505,10 @@ paths:
41051
41505
  - format: date-time
41052
41506
  type: string
41053
41507
  - type: 'null'
41508
+ description: Filter metrics after (RFC3339)
41054
41509
  title: Start Time
41055
- - in: query
41510
+ - description: Filter metrics before (RFC3339)
41511
+ in: query
41056
41512
  name: end_time
41057
41513
  required: false
41058
41514
  schema:
@@ -41060,6 +41516,7 @@ paths:
41060
41516
  - format: date-time
41061
41517
  type: string
41062
41518
  - type: 'null'
41519
+ description: Filter metrics before (RFC3339)
41063
41520
  title: End Time
41064
41521
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41065
41522
  responses:
@@ -41234,7 +41691,8 @@ paths:
41234
41691
  x-typeid-prefix: parking
41235
41692
  - type: string
41236
41693
  title: Parking Reference
41237
- - in: query
41694
+ - description: Filter metrics after (RFC3339)
41695
+ in: query
41238
41696
  name: start_time
41239
41697
  required: false
41240
41698
  schema:
@@ -41242,8 +41700,10 @@ paths:
41242
41700
  - format: date-time
41243
41701
  type: string
41244
41702
  - type: 'null'
41703
+ description: Filter metrics after (RFC3339)
41245
41704
  title: Start Time
41246
- - in: query
41705
+ - description: Filter metrics before (RFC3339)
41706
+ in: query
41247
41707
  name: end_time
41248
41708
  required: false
41249
41709
  schema:
@@ -41251,6 +41711,7 @@ paths:
41251
41711
  - format: date-time
41252
41712
  type: string
41253
41713
  - type: 'null'
41714
+ description: Filter metrics before (RFC3339)
41254
41715
  title: End Time
41255
41716
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41256
41717
  responses:
@@ -41516,18 +41977,22 @@ paths:
41516
41977
  minimum: 1
41517
41978
  title: Page Size
41518
41979
  type: integer
41519
- - in: query
41980
+ - description: Field to sort by
41981
+ in: query
41520
41982
  name: sort_by
41521
41983
  required: false
41522
41984
  schema:
41523
41985
  $ref: '#/components/schemas/TagSortField'
41524
41986
  default: label
41525
- - in: query
41987
+ description: Field to sort by
41988
+ - description: Sort order direction
41989
+ in: query
41526
41990
  name: sort_order
41527
41991
  required: false
41528
41992
  schema:
41529
41993
  $ref: '#/components/schemas/SortOrder'
41530
41994
  default: asc
41995
+ description: Sort order direction
41531
41996
  - description: Filter by tag types (OR semantics)
41532
41997
  in: query
41533
41998
  name: tag_types
@@ -41540,13 +42005,15 @@ paths:
41540
42005
  - type: 'null'
41541
42006
  description: Filter by tag types (OR semantics)
41542
42007
  title: Tag Types
41543
- - in: query
42008
+ - description: Search tags by label (contains)
42009
+ in: query
41544
42010
  name: search
41545
42011
  required: false
41546
42012
  schema:
41547
42013
  anyOf:
41548
42014
  - type: string
41549
42015
  - type: 'null'
42016
+ description: Search tags by label (contains)
41550
42017
  title: Search
41551
42018
  - $ref: '#/components/parameters/DatetimeFormatHeader'
41552
42019
  responses: