@opusdns/api 0.207.0 → 0.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/package.json +1 -1
- package/src/helpers/keys.ts +0 -179
- package/src/helpers/requests.d.ts +18 -64
- package/src/helpers/responses.d.ts +407 -153
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +0 -16
- package/src/openapi.yaml +930 -185
- package/src/schema.d.ts +459 -155
package/src/schema.d.ts
CHANGED
|
@@ -548,7 +548,10 @@ export interface paths {
|
|
|
548
548
|
path?: never;
|
|
549
549
|
cookie?: never;
|
|
550
550
|
};
|
|
551
|
-
/**
|
|
551
|
+
/**
|
|
552
|
+
* Get domain forward metrics
|
|
553
|
+
* @description Retrieves overall metrics for domain forwards including total and unique visit counts.
|
|
554
|
+
*/
|
|
552
555
|
get: operations["metrics_v1_domain_forwards_metrics_get"];
|
|
553
556
|
put?: never;
|
|
554
557
|
post?: never;
|
|
@@ -565,7 +568,10 @@ export interface paths {
|
|
|
565
568
|
path?: never;
|
|
566
569
|
cookie?: never;
|
|
567
570
|
};
|
|
568
|
-
/**
|
|
571
|
+
/**
|
|
572
|
+
* Get browser statistics
|
|
573
|
+
* @description Retrieves visitor traffic broken down by browser type (Chrome, Safari, Firefox, etc.) with total and unique visit counts.
|
|
574
|
+
*/
|
|
569
575
|
get: operations["browser_stats_v1_domain_forwards_metrics_browser_get"];
|
|
570
576
|
put?: never;
|
|
571
577
|
post?: never;
|
|
@@ -582,7 +588,10 @@ export interface paths {
|
|
|
582
588
|
path?: never;
|
|
583
589
|
cookie?: never;
|
|
584
590
|
};
|
|
585
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* Get geographic statistics
|
|
593
|
+
* @description Retrieves visitor traffic broken down by geographic location (country code) with visit counts.
|
|
594
|
+
*/
|
|
586
595
|
get: operations["geo_stats_v1_domain_forwards_metrics_geo_get"];
|
|
587
596
|
put?: never;
|
|
588
597
|
post?: never;
|
|
@@ -599,7 +608,10 @@ export interface paths {
|
|
|
599
608
|
path?: never;
|
|
600
609
|
cookie?: never;
|
|
601
610
|
};
|
|
602
|
-
/**
|
|
611
|
+
/**
|
|
612
|
+
* Get platform statistics
|
|
613
|
+
* @description Retrieves visitor traffic broken down by platform (Windows, Macintosh, iOS, Android, Linux) with total and unique visit counts.
|
|
614
|
+
*/
|
|
603
615
|
get: operations["platform_stats_v1_domain_forwards_metrics_platform_get"];
|
|
604
616
|
put?: never;
|
|
605
617
|
post?: never;
|
|
@@ -616,7 +628,10 @@ export interface paths {
|
|
|
616
628
|
path?: never;
|
|
617
629
|
cookie?: never;
|
|
618
630
|
};
|
|
619
|
-
/**
|
|
631
|
+
/**
|
|
632
|
+
* Get referrer statistics
|
|
633
|
+
* @description Retrieves visitor referral sources (where traffic came from) with total and unique visit counts.
|
|
634
|
+
*/
|
|
620
635
|
get: operations["referrer_stats_v1_domain_forwards_metrics_referrer_get"];
|
|
621
636
|
put?: never;
|
|
622
637
|
post?: never;
|
|
@@ -633,7 +648,10 @@ export interface paths {
|
|
|
633
648
|
path?: never;
|
|
634
649
|
cookie?: never;
|
|
635
650
|
};
|
|
636
|
-
/**
|
|
651
|
+
/**
|
|
652
|
+
* Get HTTP status code statistics
|
|
653
|
+
* @description Retrieves distribution of HTTP redirect status codes (301, 302, 307, 308) used across forwards.
|
|
654
|
+
*/
|
|
637
655
|
get: operations["status_code_stats_v1_domain_forwards_metrics_status_code_get"];
|
|
638
656
|
put?: never;
|
|
639
657
|
post?: never;
|
|
@@ -650,7 +668,10 @@ export interface paths {
|
|
|
650
668
|
path?: never;
|
|
651
669
|
cookie?: never;
|
|
652
670
|
};
|
|
653
|
-
/**
|
|
671
|
+
/**
|
|
672
|
+
* Get domain forward time series metrics
|
|
673
|
+
* @description Retrieves visit counts bucketed by time intervals (hourly, daily) for the specified time range.
|
|
674
|
+
*/
|
|
654
675
|
get: operations["time_series_v1_domain_forwards_metrics_time_series_get"];
|
|
655
676
|
put?: never;
|
|
656
677
|
post?: never;
|
|
@@ -667,7 +688,10 @@ export interface paths {
|
|
|
667
688
|
path?: never;
|
|
668
689
|
cookie?: never;
|
|
669
690
|
};
|
|
670
|
-
/**
|
|
691
|
+
/**
|
|
692
|
+
* Get user agent statistics
|
|
693
|
+
* @description Retrieves visitor traffic broken down by user agent string with total and unique visit counts.
|
|
694
|
+
*/
|
|
671
695
|
get: operations["user_agent_stats_v1_domain_forwards_metrics_user_agent_get"];
|
|
672
696
|
put?: never;
|
|
673
697
|
post?: never;
|
|
@@ -684,7 +708,10 @@ export interface paths {
|
|
|
684
708
|
path?: never;
|
|
685
709
|
cookie?: never;
|
|
686
710
|
};
|
|
687
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Get visits grouped by key
|
|
713
|
+
* @description Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
|
|
714
|
+
*/
|
|
688
715
|
get: operations["visits_by_key_v1_domain_forwards_metrics_visits_by_key_get"];
|
|
689
716
|
put?: never;
|
|
690
717
|
post?: never;
|
|
@@ -779,12 +806,7 @@ export interface paths {
|
|
|
779
806
|
* @description Updates an existing domain forward set for a specific protocol (HTTP or HTTPS). All existing redirects for this protocol are replaced with the provided redirects. Raises an error if the set does not exist.
|
|
780
807
|
*/
|
|
781
808
|
put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
|
|
782
|
-
|
|
783
|
-
* Create domain forward set (deprecated)
|
|
784
|
-
* @deprecated
|
|
785
|
-
* @description Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
786
|
-
*/
|
|
787
|
-
post: operations["create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post"];
|
|
809
|
+
post?: never;
|
|
788
810
|
/**
|
|
789
811
|
* Delete domain forward set
|
|
790
812
|
* @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
@@ -3336,7 +3358,7 @@ export interface components {
|
|
|
3336
3358
|
/** DomainForwardProtocolSetRequest */
|
|
3337
3359
|
DomainForwardProtocolSetRequest: {
|
|
3338
3360
|
/** Redirects */
|
|
3339
|
-
redirects:
|
|
3361
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3340
3362
|
};
|
|
3341
3363
|
/** DomainForwardProtocolSetResponse */
|
|
3342
3364
|
DomainForwardProtocolSetResponse: {
|
|
@@ -3362,12 +3384,12 @@ export interface components {
|
|
|
3362
3384
|
DomainForwardSetCreateRequest: {
|
|
3363
3385
|
protocol: components["schemas"]["HttpProtocol"];
|
|
3364
3386
|
/** Redirects */
|
|
3365
|
-
redirects:
|
|
3387
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3366
3388
|
};
|
|
3367
3389
|
/** DomainForwardSetRequest */
|
|
3368
3390
|
DomainForwardSetRequest: {
|
|
3369
3391
|
/** Redirects */
|
|
3370
|
-
redirects:
|
|
3392
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3371
3393
|
};
|
|
3372
3394
|
/** DomainForwardSetResponse */
|
|
3373
3395
|
DomainForwardSetResponse: {
|
|
@@ -6681,19 +6703,6 @@ export interface components {
|
|
|
6681
6703
|
*/
|
|
6682
6704
|
whois_server?: string | null;
|
|
6683
6705
|
};
|
|
6684
|
-
/** WildcardHttpRedirectRequest */
|
|
6685
|
-
WildcardHttpRedirectRequest: {
|
|
6686
|
-
redirect_code: components["schemas"]["RedirectCode"];
|
|
6687
|
-
/** Request Path */
|
|
6688
|
-
request_path: string;
|
|
6689
|
-
/** Request Subdomain */
|
|
6690
|
-
request_subdomain: string;
|
|
6691
|
-
/** Target Hostname */
|
|
6692
|
-
target_hostname: string;
|
|
6693
|
-
/** Target Path */
|
|
6694
|
-
target_path: string;
|
|
6695
|
-
target_protocol: components["schemas"]["HttpProtocol"];
|
|
6696
|
-
};
|
|
6697
6706
|
/**
|
|
6698
6707
|
* ZoneSortField
|
|
6699
6708
|
* @enum {string}
|
|
@@ -8825,7 +8834,7 @@ export interface operations {
|
|
|
8825
8834
|
};
|
|
8826
8835
|
requestBody?: never;
|
|
8827
8836
|
responses: {
|
|
8828
|
-
/** @description
|
|
8837
|
+
/** @description List of domain forwards retrieved successfully */
|
|
8829
8838
|
200: {
|
|
8830
8839
|
headers: {
|
|
8831
8840
|
[name: string]: unknown;
|
|
@@ -8948,7 +8957,7 @@ export interface operations {
|
|
|
8948
8957
|
"application/problem+json": components["schemas"]["Problem"];
|
|
8949
8958
|
};
|
|
8950
8959
|
};
|
|
8951
|
-
/** @description Domain forward already exists */
|
|
8960
|
+
/** @description Domain forward already exists for this hostname */
|
|
8952
8961
|
409: {
|
|
8953
8962
|
headers: {
|
|
8954
8963
|
[name: string]: unknown;
|
|
@@ -8988,7 +8997,7 @@ export interface operations {
|
|
|
8988
8997
|
};
|
|
8989
8998
|
};
|
|
8990
8999
|
responses: {
|
|
8991
|
-
/** @description
|
|
9000
|
+
/** @description Domain forward redirects updated successfully. */
|
|
8992
9001
|
204: {
|
|
8993
9002
|
headers: {
|
|
8994
9003
|
[name: string]: unknown;
|
|
@@ -9072,7 +9081,7 @@ export interface operations {
|
|
|
9072
9081
|
};
|
|
9073
9082
|
requestBody?: never;
|
|
9074
9083
|
responses: {
|
|
9075
|
-
/** @description
|
|
9084
|
+
/** @description Domain forward metrics retrieved successfully */
|
|
9076
9085
|
200: {
|
|
9077
9086
|
headers: {
|
|
9078
9087
|
[name: string]: unknown;
|
|
@@ -9081,6 +9090,50 @@ export interface operations {
|
|
|
9081
9090
|
"application/json": components["schemas"]["DomainForwardMetricsResponse"];
|
|
9082
9091
|
};
|
|
9083
9092
|
};
|
|
9093
|
+
/** @description Invalid query parameters */
|
|
9094
|
+
400: {
|
|
9095
|
+
headers: {
|
|
9096
|
+
[name: string]: unknown;
|
|
9097
|
+
};
|
|
9098
|
+
content: {
|
|
9099
|
+
/** @example {
|
|
9100
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9101
|
+
* } */
|
|
9102
|
+
"application/json": unknown;
|
|
9103
|
+
};
|
|
9104
|
+
};
|
|
9105
|
+
/** @description Unauthorized */
|
|
9106
|
+
401: {
|
|
9107
|
+
headers: {
|
|
9108
|
+
[name: string]: unknown;
|
|
9109
|
+
};
|
|
9110
|
+
content: {
|
|
9111
|
+
/** @example {
|
|
9112
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9113
|
+
* "detail": "Additional error context.",
|
|
9114
|
+
* "status": 401,
|
|
9115
|
+
* "title": "Authentication Error",
|
|
9116
|
+
* "type": "authentication"
|
|
9117
|
+
* } */
|
|
9118
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9119
|
+
};
|
|
9120
|
+
};
|
|
9121
|
+
/** @description Forbidden */
|
|
9122
|
+
403: {
|
|
9123
|
+
headers: {
|
|
9124
|
+
[name: string]: unknown;
|
|
9125
|
+
};
|
|
9126
|
+
content: {
|
|
9127
|
+
/** @example {
|
|
9128
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9129
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9130
|
+
* "status": 403,
|
|
9131
|
+
* "title": "Permission Denied",
|
|
9132
|
+
* "type": "permission-denied"
|
|
9133
|
+
* } */
|
|
9134
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9135
|
+
};
|
|
9136
|
+
};
|
|
9084
9137
|
/** @description Validation Error */
|
|
9085
9138
|
422: {
|
|
9086
9139
|
headers: {
|
|
@@ -9110,7 +9163,7 @@ export interface operations {
|
|
|
9110
9163
|
};
|
|
9111
9164
|
requestBody?: never;
|
|
9112
9165
|
responses: {
|
|
9113
|
-
/** @description
|
|
9166
|
+
/** @description Browser statistics retrieved successfully */
|
|
9114
9167
|
200: {
|
|
9115
9168
|
headers: {
|
|
9116
9169
|
[name: string]: unknown;
|
|
@@ -9119,6 +9172,50 @@ export interface operations {
|
|
|
9119
9172
|
"application/json": components["schemas"]["DomainForwardBrowserStatsResponse"];
|
|
9120
9173
|
};
|
|
9121
9174
|
};
|
|
9175
|
+
/** @description Invalid query parameters */
|
|
9176
|
+
400: {
|
|
9177
|
+
headers: {
|
|
9178
|
+
[name: string]: unknown;
|
|
9179
|
+
};
|
|
9180
|
+
content: {
|
|
9181
|
+
/** @example {
|
|
9182
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9183
|
+
* } */
|
|
9184
|
+
"application/json": unknown;
|
|
9185
|
+
};
|
|
9186
|
+
};
|
|
9187
|
+
/** @description Unauthorized */
|
|
9188
|
+
401: {
|
|
9189
|
+
headers: {
|
|
9190
|
+
[name: string]: unknown;
|
|
9191
|
+
};
|
|
9192
|
+
content: {
|
|
9193
|
+
/** @example {
|
|
9194
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9195
|
+
* "detail": "Additional error context.",
|
|
9196
|
+
* "status": 401,
|
|
9197
|
+
* "title": "Authentication Error",
|
|
9198
|
+
* "type": "authentication"
|
|
9199
|
+
* } */
|
|
9200
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9201
|
+
};
|
|
9202
|
+
};
|
|
9203
|
+
/** @description Forbidden */
|
|
9204
|
+
403: {
|
|
9205
|
+
headers: {
|
|
9206
|
+
[name: string]: unknown;
|
|
9207
|
+
};
|
|
9208
|
+
content: {
|
|
9209
|
+
/** @example {
|
|
9210
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9211
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9212
|
+
* "status": 403,
|
|
9213
|
+
* "title": "Permission Denied",
|
|
9214
|
+
* "type": "permission-denied"
|
|
9215
|
+
* } */
|
|
9216
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9217
|
+
};
|
|
9218
|
+
};
|
|
9122
9219
|
/** @description Validation Error */
|
|
9123
9220
|
422: {
|
|
9124
9221
|
headers: {
|
|
@@ -9148,7 +9245,7 @@ export interface operations {
|
|
|
9148
9245
|
};
|
|
9149
9246
|
requestBody?: never;
|
|
9150
9247
|
responses: {
|
|
9151
|
-
/** @description
|
|
9248
|
+
/** @description Geographic statistics retrieved successfully */
|
|
9152
9249
|
200: {
|
|
9153
9250
|
headers: {
|
|
9154
9251
|
[name: string]: unknown;
|
|
@@ -9157,6 +9254,50 @@ export interface operations {
|
|
|
9157
9254
|
"application/json": components["schemas"]["DomainForwardGeoStatsResponse"];
|
|
9158
9255
|
};
|
|
9159
9256
|
};
|
|
9257
|
+
/** @description Invalid query parameters */
|
|
9258
|
+
400: {
|
|
9259
|
+
headers: {
|
|
9260
|
+
[name: string]: unknown;
|
|
9261
|
+
};
|
|
9262
|
+
content: {
|
|
9263
|
+
/** @example {
|
|
9264
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9265
|
+
* } */
|
|
9266
|
+
"application/json": unknown;
|
|
9267
|
+
};
|
|
9268
|
+
};
|
|
9269
|
+
/** @description Unauthorized */
|
|
9270
|
+
401: {
|
|
9271
|
+
headers: {
|
|
9272
|
+
[name: string]: unknown;
|
|
9273
|
+
};
|
|
9274
|
+
content: {
|
|
9275
|
+
/** @example {
|
|
9276
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9277
|
+
* "detail": "Additional error context.",
|
|
9278
|
+
* "status": 401,
|
|
9279
|
+
* "title": "Authentication Error",
|
|
9280
|
+
* "type": "authentication"
|
|
9281
|
+
* } */
|
|
9282
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9283
|
+
};
|
|
9284
|
+
};
|
|
9285
|
+
/** @description Forbidden */
|
|
9286
|
+
403: {
|
|
9287
|
+
headers: {
|
|
9288
|
+
[name: string]: unknown;
|
|
9289
|
+
};
|
|
9290
|
+
content: {
|
|
9291
|
+
/** @example {
|
|
9292
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9293
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9294
|
+
* "status": 403,
|
|
9295
|
+
* "title": "Permission Denied",
|
|
9296
|
+
* "type": "permission-denied"
|
|
9297
|
+
* } */
|
|
9298
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9299
|
+
};
|
|
9300
|
+
};
|
|
9160
9301
|
/** @description Validation Error */
|
|
9161
9302
|
422: {
|
|
9162
9303
|
headers: {
|
|
@@ -9186,7 +9327,7 @@ export interface operations {
|
|
|
9186
9327
|
};
|
|
9187
9328
|
requestBody?: never;
|
|
9188
9329
|
responses: {
|
|
9189
|
-
/** @description
|
|
9330
|
+
/** @description Platform statistics retrieved successfully */
|
|
9190
9331
|
200: {
|
|
9191
9332
|
headers: {
|
|
9192
9333
|
[name: string]: unknown;
|
|
@@ -9195,6 +9336,50 @@ export interface operations {
|
|
|
9195
9336
|
"application/json": components["schemas"]["DomainForwardPlatformStatsResponse"];
|
|
9196
9337
|
};
|
|
9197
9338
|
};
|
|
9339
|
+
/** @description Invalid query parameters */
|
|
9340
|
+
400: {
|
|
9341
|
+
headers: {
|
|
9342
|
+
[name: string]: unknown;
|
|
9343
|
+
};
|
|
9344
|
+
content: {
|
|
9345
|
+
/** @example {
|
|
9346
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9347
|
+
* } */
|
|
9348
|
+
"application/json": unknown;
|
|
9349
|
+
};
|
|
9350
|
+
};
|
|
9351
|
+
/** @description Unauthorized */
|
|
9352
|
+
401: {
|
|
9353
|
+
headers: {
|
|
9354
|
+
[name: string]: unknown;
|
|
9355
|
+
};
|
|
9356
|
+
content: {
|
|
9357
|
+
/** @example {
|
|
9358
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9359
|
+
* "detail": "Additional error context.",
|
|
9360
|
+
* "status": 401,
|
|
9361
|
+
* "title": "Authentication Error",
|
|
9362
|
+
* "type": "authentication"
|
|
9363
|
+
* } */
|
|
9364
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9365
|
+
};
|
|
9366
|
+
};
|
|
9367
|
+
/** @description Forbidden */
|
|
9368
|
+
403: {
|
|
9369
|
+
headers: {
|
|
9370
|
+
[name: string]: unknown;
|
|
9371
|
+
};
|
|
9372
|
+
content: {
|
|
9373
|
+
/** @example {
|
|
9374
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9375
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9376
|
+
* "status": 403,
|
|
9377
|
+
* "title": "Permission Denied",
|
|
9378
|
+
* "type": "permission-denied"
|
|
9379
|
+
* } */
|
|
9380
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9381
|
+
};
|
|
9382
|
+
};
|
|
9198
9383
|
/** @description Validation Error */
|
|
9199
9384
|
422: {
|
|
9200
9385
|
headers: {
|
|
@@ -9224,7 +9409,7 @@ export interface operations {
|
|
|
9224
9409
|
};
|
|
9225
9410
|
requestBody?: never;
|
|
9226
9411
|
responses: {
|
|
9227
|
-
/** @description
|
|
9412
|
+
/** @description Referrer statistics retrieved successfully */
|
|
9228
9413
|
200: {
|
|
9229
9414
|
headers: {
|
|
9230
9415
|
[name: string]: unknown;
|
|
@@ -9233,6 +9418,50 @@ export interface operations {
|
|
|
9233
9418
|
"application/json": components["schemas"]["DomainForwardReferrerStatsResponse"];
|
|
9234
9419
|
};
|
|
9235
9420
|
};
|
|
9421
|
+
/** @description Invalid query parameters */
|
|
9422
|
+
400: {
|
|
9423
|
+
headers: {
|
|
9424
|
+
[name: string]: unknown;
|
|
9425
|
+
};
|
|
9426
|
+
content: {
|
|
9427
|
+
/** @example {
|
|
9428
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9429
|
+
* } */
|
|
9430
|
+
"application/json": unknown;
|
|
9431
|
+
};
|
|
9432
|
+
};
|
|
9433
|
+
/** @description Unauthorized */
|
|
9434
|
+
401: {
|
|
9435
|
+
headers: {
|
|
9436
|
+
[name: string]: unknown;
|
|
9437
|
+
};
|
|
9438
|
+
content: {
|
|
9439
|
+
/** @example {
|
|
9440
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9441
|
+
* "detail": "Additional error context.",
|
|
9442
|
+
* "status": 401,
|
|
9443
|
+
* "title": "Authentication Error",
|
|
9444
|
+
* "type": "authentication"
|
|
9445
|
+
* } */
|
|
9446
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9447
|
+
};
|
|
9448
|
+
};
|
|
9449
|
+
/** @description Forbidden */
|
|
9450
|
+
403: {
|
|
9451
|
+
headers: {
|
|
9452
|
+
[name: string]: unknown;
|
|
9453
|
+
};
|
|
9454
|
+
content: {
|
|
9455
|
+
/** @example {
|
|
9456
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9457
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9458
|
+
* "status": 403,
|
|
9459
|
+
* "title": "Permission Denied",
|
|
9460
|
+
* "type": "permission-denied"
|
|
9461
|
+
* } */
|
|
9462
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9463
|
+
};
|
|
9464
|
+
};
|
|
9236
9465
|
/** @description Validation Error */
|
|
9237
9466
|
422: {
|
|
9238
9467
|
headers: {
|
|
@@ -9262,7 +9491,7 @@ export interface operations {
|
|
|
9262
9491
|
};
|
|
9263
9492
|
requestBody?: never;
|
|
9264
9493
|
responses: {
|
|
9265
|
-
/** @description
|
|
9494
|
+
/** @description Status code statistics retrieved successfully */
|
|
9266
9495
|
200: {
|
|
9267
9496
|
headers: {
|
|
9268
9497
|
[name: string]: unknown;
|
|
@@ -9271,13 +9500,57 @@ export interface operations {
|
|
|
9271
9500
|
"application/json": components["schemas"]["DomainForwardStatusCodeStatsResponse"];
|
|
9272
9501
|
};
|
|
9273
9502
|
};
|
|
9274
|
-
/** @description
|
|
9275
|
-
|
|
9503
|
+
/** @description Invalid query parameters */
|
|
9504
|
+
400: {
|
|
9276
9505
|
headers: {
|
|
9277
9506
|
[name: string]: unknown;
|
|
9278
9507
|
};
|
|
9279
9508
|
content: {
|
|
9280
|
-
|
|
9509
|
+
/** @example {
|
|
9510
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9511
|
+
* } */
|
|
9512
|
+
"application/json": unknown;
|
|
9513
|
+
};
|
|
9514
|
+
};
|
|
9515
|
+
/** @description Unauthorized */
|
|
9516
|
+
401: {
|
|
9517
|
+
headers: {
|
|
9518
|
+
[name: string]: unknown;
|
|
9519
|
+
};
|
|
9520
|
+
content: {
|
|
9521
|
+
/** @example {
|
|
9522
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9523
|
+
* "detail": "Additional error context.",
|
|
9524
|
+
* "status": 401,
|
|
9525
|
+
* "title": "Authentication Error",
|
|
9526
|
+
* "type": "authentication"
|
|
9527
|
+
* } */
|
|
9528
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9529
|
+
};
|
|
9530
|
+
};
|
|
9531
|
+
/** @description Forbidden */
|
|
9532
|
+
403: {
|
|
9533
|
+
headers: {
|
|
9534
|
+
[name: string]: unknown;
|
|
9535
|
+
};
|
|
9536
|
+
content: {
|
|
9537
|
+
/** @example {
|
|
9538
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9539
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9540
|
+
* "status": 403,
|
|
9541
|
+
* "title": "Permission Denied",
|
|
9542
|
+
* "type": "permission-denied"
|
|
9543
|
+
* } */
|
|
9544
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9545
|
+
};
|
|
9546
|
+
};
|
|
9547
|
+
/** @description Validation Error */
|
|
9548
|
+
422: {
|
|
9549
|
+
headers: {
|
|
9550
|
+
[name: string]: unknown;
|
|
9551
|
+
};
|
|
9552
|
+
content: {
|
|
9553
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
9281
9554
|
};
|
|
9282
9555
|
};
|
|
9283
9556
|
};
|
|
@@ -9300,7 +9573,7 @@ export interface operations {
|
|
|
9300
9573
|
};
|
|
9301
9574
|
requestBody?: never;
|
|
9302
9575
|
responses: {
|
|
9303
|
-
/** @description
|
|
9576
|
+
/** @description Time series metrics retrieved successfully */
|
|
9304
9577
|
200: {
|
|
9305
9578
|
headers: {
|
|
9306
9579
|
[name: string]: unknown;
|
|
@@ -9309,6 +9582,50 @@ export interface operations {
|
|
|
9309
9582
|
"application/json": components["schemas"]["DomainForwardMetricsTimeSeriesResponse"];
|
|
9310
9583
|
};
|
|
9311
9584
|
};
|
|
9585
|
+
/** @description Invalid query parameters */
|
|
9586
|
+
400: {
|
|
9587
|
+
headers: {
|
|
9588
|
+
[name: string]: unknown;
|
|
9589
|
+
};
|
|
9590
|
+
content: {
|
|
9591
|
+
/** @example {
|
|
9592
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9593
|
+
* } */
|
|
9594
|
+
"application/json": unknown;
|
|
9595
|
+
};
|
|
9596
|
+
};
|
|
9597
|
+
/** @description Unauthorized */
|
|
9598
|
+
401: {
|
|
9599
|
+
headers: {
|
|
9600
|
+
[name: string]: unknown;
|
|
9601
|
+
};
|
|
9602
|
+
content: {
|
|
9603
|
+
/** @example {
|
|
9604
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9605
|
+
* "detail": "Additional error context.",
|
|
9606
|
+
* "status": 401,
|
|
9607
|
+
* "title": "Authentication Error",
|
|
9608
|
+
* "type": "authentication"
|
|
9609
|
+
* } */
|
|
9610
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9611
|
+
};
|
|
9612
|
+
};
|
|
9613
|
+
/** @description Forbidden */
|
|
9614
|
+
403: {
|
|
9615
|
+
headers: {
|
|
9616
|
+
[name: string]: unknown;
|
|
9617
|
+
};
|
|
9618
|
+
content: {
|
|
9619
|
+
/** @example {
|
|
9620
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9621
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9622
|
+
* "status": 403,
|
|
9623
|
+
* "title": "Permission Denied",
|
|
9624
|
+
* "type": "permission-denied"
|
|
9625
|
+
* } */
|
|
9626
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9627
|
+
};
|
|
9628
|
+
};
|
|
9312
9629
|
/** @description Validation Error */
|
|
9313
9630
|
422: {
|
|
9314
9631
|
headers: {
|
|
@@ -9338,7 +9655,7 @@ export interface operations {
|
|
|
9338
9655
|
};
|
|
9339
9656
|
requestBody?: never;
|
|
9340
9657
|
responses: {
|
|
9341
|
-
/** @description
|
|
9658
|
+
/** @description User agent statistics retrieved successfully */
|
|
9342
9659
|
200: {
|
|
9343
9660
|
headers: {
|
|
9344
9661
|
[name: string]: unknown;
|
|
@@ -9347,6 +9664,50 @@ export interface operations {
|
|
|
9347
9664
|
"application/json": components["schemas"]["DomainForwardUserAgentStatsResponse"];
|
|
9348
9665
|
};
|
|
9349
9666
|
};
|
|
9667
|
+
/** @description Invalid query parameters */
|
|
9668
|
+
400: {
|
|
9669
|
+
headers: {
|
|
9670
|
+
[name: string]: unknown;
|
|
9671
|
+
};
|
|
9672
|
+
content: {
|
|
9673
|
+
/** @example {
|
|
9674
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9675
|
+
* } */
|
|
9676
|
+
"application/json": unknown;
|
|
9677
|
+
};
|
|
9678
|
+
};
|
|
9679
|
+
/** @description Unauthorized */
|
|
9680
|
+
401: {
|
|
9681
|
+
headers: {
|
|
9682
|
+
[name: string]: unknown;
|
|
9683
|
+
};
|
|
9684
|
+
content: {
|
|
9685
|
+
/** @example {
|
|
9686
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9687
|
+
* "detail": "Additional error context.",
|
|
9688
|
+
* "status": 401,
|
|
9689
|
+
* "title": "Authentication Error",
|
|
9690
|
+
* "type": "authentication"
|
|
9691
|
+
* } */
|
|
9692
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9693
|
+
};
|
|
9694
|
+
};
|
|
9695
|
+
/** @description Forbidden */
|
|
9696
|
+
403: {
|
|
9697
|
+
headers: {
|
|
9698
|
+
[name: string]: unknown;
|
|
9699
|
+
};
|
|
9700
|
+
content: {
|
|
9701
|
+
/** @example {
|
|
9702
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9703
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9704
|
+
* "status": 403,
|
|
9705
|
+
* "title": "Permission Denied",
|
|
9706
|
+
* "type": "permission-denied"
|
|
9707
|
+
* } */
|
|
9708
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9709
|
+
};
|
|
9710
|
+
};
|
|
9350
9711
|
/** @description Validation Error */
|
|
9351
9712
|
422: {
|
|
9352
9713
|
headers: {
|
|
@@ -9378,7 +9739,7 @@ export interface operations {
|
|
|
9378
9739
|
};
|
|
9379
9740
|
requestBody?: never;
|
|
9380
9741
|
responses: {
|
|
9381
|
-
/** @description
|
|
9742
|
+
/** @description Visits by key statistics retrieved successfully */
|
|
9382
9743
|
200: {
|
|
9383
9744
|
headers: {
|
|
9384
9745
|
[name: string]: unknown;
|
|
@@ -9387,6 +9748,50 @@ export interface operations {
|
|
|
9387
9748
|
"application/json": components["schemas"]["DomainForwardVisitsByKeyResponse"];
|
|
9388
9749
|
};
|
|
9389
9750
|
};
|
|
9751
|
+
/** @description Invalid query parameters */
|
|
9752
|
+
400: {
|
|
9753
|
+
headers: {
|
|
9754
|
+
[name: string]: unknown;
|
|
9755
|
+
};
|
|
9756
|
+
content: {
|
|
9757
|
+
/** @example {
|
|
9758
|
+
* "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
|
|
9759
|
+
* } */
|
|
9760
|
+
"application/json": unknown;
|
|
9761
|
+
};
|
|
9762
|
+
};
|
|
9763
|
+
/** @description Unauthorized */
|
|
9764
|
+
401: {
|
|
9765
|
+
headers: {
|
|
9766
|
+
[name: string]: unknown;
|
|
9767
|
+
};
|
|
9768
|
+
content: {
|
|
9769
|
+
/** @example {
|
|
9770
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
9771
|
+
* "detail": "Additional error context.",
|
|
9772
|
+
* "status": 401,
|
|
9773
|
+
* "title": "Authentication Error",
|
|
9774
|
+
* "type": "authentication"
|
|
9775
|
+
* } */
|
|
9776
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9777
|
+
};
|
|
9778
|
+
};
|
|
9779
|
+
/** @description Forbidden */
|
|
9780
|
+
403: {
|
|
9781
|
+
headers: {
|
|
9782
|
+
[name: string]: unknown;
|
|
9783
|
+
};
|
|
9784
|
+
content: {
|
|
9785
|
+
/** @example {
|
|
9786
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
9787
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
9788
|
+
* "status": 403,
|
|
9789
|
+
* "title": "Permission Denied",
|
|
9790
|
+
* "type": "permission-denied"
|
|
9791
|
+
* } */
|
|
9792
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
9793
|
+
};
|
|
9794
|
+
};
|
|
9390
9795
|
/** @description Validation Error */
|
|
9391
9796
|
422: {
|
|
9392
9797
|
headers: {
|
|
@@ -9410,7 +9815,7 @@ export interface operations {
|
|
|
9410
9815
|
};
|
|
9411
9816
|
requestBody?: never;
|
|
9412
9817
|
responses: {
|
|
9413
|
-
/** @description
|
|
9818
|
+
/** @description Domain forward retrieved successfully */
|
|
9414
9819
|
200: {
|
|
9415
9820
|
headers: {
|
|
9416
9821
|
[name: string]: unknown;
|
|
@@ -9494,7 +9899,7 @@ export interface operations {
|
|
|
9494
9899
|
};
|
|
9495
9900
|
};
|
|
9496
9901
|
responses: {
|
|
9497
|
-
/** @description
|
|
9902
|
+
/** @description Domain forward protocol set created successfully */
|
|
9498
9903
|
201: {
|
|
9499
9904
|
headers: {
|
|
9500
9905
|
[name: string]: unknown;
|
|
@@ -9590,7 +9995,7 @@ export interface operations {
|
|
|
9590
9995
|
};
|
|
9591
9996
|
requestBody?: never;
|
|
9592
9997
|
responses: {
|
|
9593
|
-
/** @description
|
|
9998
|
+
/** @description Domain forward deleted successfully. No content returned. */
|
|
9594
9999
|
204: {
|
|
9595
10000
|
headers: {
|
|
9596
10001
|
[name: string]: unknown;
|
|
@@ -9668,7 +10073,7 @@ export interface operations {
|
|
|
9668
10073
|
};
|
|
9669
10074
|
requestBody?: never;
|
|
9670
10075
|
responses: {
|
|
9671
|
-
/** @description
|
|
10076
|
+
/** @description Domain forward disabled successfully. DNS records have been removed but configuration is preserved. */
|
|
9672
10077
|
204: {
|
|
9673
10078
|
headers: {
|
|
9674
10079
|
[name: string]: unknown;
|
|
@@ -9730,7 +10135,7 @@ export interface operations {
|
|
|
9730
10135
|
};
|
|
9731
10136
|
requestBody?: never;
|
|
9732
10137
|
responses: {
|
|
9733
|
-
/** @description
|
|
10138
|
+
/** @description Domain forward enabled successfully. DNS records have been created. */
|
|
9734
10139
|
204: {
|
|
9735
10140
|
headers: {
|
|
9736
10141
|
[name: string]: unknown;
|
|
@@ -9793,7 +10198,7 @@ export interface operations {
|
|
|
9793
10198
|
};
|
|
9794
10199
|
requestBody?: never;
|
|
9795
10200
|
responses: {
|
|
9796
|
-
/** @description
|
|
10201
|
+
/** @description Domain forward set retrieved successfully */
|
|
9797
10202
|
200: {
|
|
9798
10203
|
headers: {
|
|
9799
10204
|
[name: string]: unknown;
|
|
@@ -9878,7 +10283,7 @@ export interface operations {
|
|
|
9878
10283
|
};
|
|
9879
10284
|
};
|
|
9880
10285
|
responses: {
|
|
9881
|
-
/** @description
|
|
10286
|
+
/** @description Domain forward protocol set updated successfully */
|
|
9882
10287
|
200: {
|
|
9883
10288
|
headers: {
|
|
9884
10289
|
[name: string]: unknown;
|
|
@@ -9946,107 +10351,6 @@ export interface operations {
|
|
|
9946
10351
|
};
|
|
9947
10352
|
};
|
|
9948
10353
|
};
|
|
9949
|
-
create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post: {
|
|
9950
|
-
parameters: {
|
|
9951
|
-
query?: never;
|
|
9952
|
-
header?: never;
|
|
9953
|
-
path: {
|
|
9954
|
-
protocol: components["schemas"]["HttpProtocol"];
|
|
9955
|
-
/** @description Hostname */
|
|
9956
|
-
hostname: string;
|
|
9957
|
-
};
|
|
9958
|
-
cookie?: never;
|
|
9959
|
-
};
|
|
9960
|
-
requestBody: {
|
|
9961
|
-
content: {
|
|
9962
|
-
"application/json": components["schemas"]["DomainForwardSetRequest"];
|
|
9963
|
-
};
|
|
9964
|
-
};
|
|
9965
|
-
responses: {
|
|
9966
|
-
/** @description Successful Response */
|
|
9967
|
-
201: {
|
|
9968
|
-
headers: {
|
|
9969
|
-
[name: string]: unknown;
|
|
9970
|
-
};
|
|
9971
|
-
content: {
|
|
9972
|
-
"application/json": components["schemas"]["DomainForwardSetResponse"];
|
|
9973
|
-
};
|
|
9974
|
-
};
|
|
9975
|
-
/** @description Unauthorized */
|
|
9976
|
-
401: {
|
|
9977
|
-
headers: {
|
|
9978
|
-
[name: string]: unknown;
|
|
9979
|
-
};
|
|
9980
|
-
content: {
|
|
9981
|
-
/** @example {
|
|
9982
|
-
* "code": "ERROR_AUTHENTICATION",
|
|
9983
|
-
* "detail": "Additional error context.",
|
|
9984
|
-
* "status": 401,
|
|
9985
|
-
* "title": "Authentication Error",
|
|
9986
|
-
* "type": "authentication"
|
|
9987
|
-
* } */
|
|
9988
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
9989
|
-
};
|
|
9990
|
-
};
|
|
9991
|
-
/** @description Forbidden */
|
|
9992
|
-
403: {
|
|
9993
|
-
headers: {
|
|
9994
|
-
[name: string]: unknown;
|
|
9995
|
-
};
|
|
9996
|
-
content: {
|
|
9997
|
-
/** @example {
|
|
9998
|
-
* "code": "ERROR_PERMISSION_DENIED",
|
|
9999
|
-
* "detail": "Insufficient permissions to perform this action",
|
|
10000
|
-
* "status": 403,
|
|
10001
|
-
* "title": "Permission Denied",
|
|
10002
|
-
* "type": "permission-denied"
|
|
10003
|
-
* } */
|
|
10004
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10005
|
-
};
|
|
10006
|
-
};
|
|
10007
|
-
/** @description Not Found */
|
|
10008
|
-
404: {
|
|
10009
|
-
headers: {
|
|
10010
|
-
[name: string]: unknown;
|
|
10011
|
-
};
|
|
10012
|
-
content: {
|
|
10013
|
-
/** @example {
|
|
10014
|
-
* "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
|
|
10015
|
-
* "detail": "Domain forward not found for Additional error context.",
|
|
10016
|
-
* "status": 404,
|
|
10017
|
-
* "title": "Domain Forward Error",
|
|
10018
|
-
* "type": "domain-forward-not-found"
|
|
10019
|
-
* } */
|
|
10020
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10021
|
-
};
|
|
10022
|
-
};
|
|
10023
|
-
/** @description Conflict */
|
|
10024
|
-
409: {
|
|
10025
|
-
headers: {
|
|
10026
|
-
[name: string]: unknown;
|
|
10027
|
-
};
|
|
10028
|
-
content: {
|
|
10029
|
-
/** @example {
|
|
10030
|
-
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
10031
|
-
* "detail": "Domain forward already exists for Additional error context.",
|
|
10032
|
-
* "status": 409,
|
|
10033
|
-
* "title": "Domain Forward Error",
|
|
10034
|
-
* "type": "domain-forward-already-exists"
|
|
10035
|
-
* } */
|
|
10036
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10037
|
-
};
|
|
10038
|
-
};
|
|
10039
|
-
/** @description Validation Error */
|
|
10040
|
-
422: {
|
|
10041
|
-
headers: {
|
|
10042
|
-
[name: string]: unknown;
|
|
10043
|
-
};
|
|
10044
|
-
content: {
|
|
10045
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
10046
|
-
};
|
|
10047
|
-
};
|
|
10048
|
-
};
|
|
10049
|
-
};
|
|
10050
10354
|
delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete: {
|
|
10051
10355
|
parameters: {
|
|
10052
10356
|
query?: never;
|
|
@@ -10060,7 +10364,7 @@ export interface operations {
|
|
|
10060
10364
|
};
|
|
10061
10365
|
requestBody?: never;
|
|
10062
10366
|
responses: {
|
|
10063
|
-
/** @description
|
|
10367
|
+
/** @description Domain forward protocol set deleted successfully. No content returned. */
|
|
10064
10368
|
204: {
|
|
10065
10369
|
headers: {
|
|
10066
10370
|
[name: string]: unknown;
|