@opusdns/api 0.111.0 → 0.113.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/constants.ts +109 -1
- package/src/helpers/keys.ts +490 -0
- package/src/helpers/requests.d.ts +245 -164
- package/src/helpers/responses.d.ts +896 -139
- package/src/helpers/schemas-arrays.d.ts +48 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +800 -189
- package/src/schema.d.ts +897 -121
package/src/openapi.yaml
CHANGED
|
@@ -2485,15 +2485,38 @@ components:
|
|
|
2485
2485
|
alias:
|
|
2486
2486
|
title: Alias
|
|
2487
2487
|
type: string
|
|
2488
|
+
email_forward_alias_id:
|
|
2489
|
+
examples:
|
|
2490
|
+
- email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
|
|
2491
|
+
format: typeid
|
|
2492
|
+
pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
2493
|
+
title: Email Forward Alias Id
|
|
2494
|
+
type: string
|
|
2495
|
+
x-typeid-prefix: email_forward_alias
|
|
2488
2496
|
forward_to:
|
|
2489
2497
|
format: email
|
|
2490
2498
|
title: Forward To
|
|
2491
2499
|
type: string
|
|
2492
2500
|
required:
|
|
2493
|
-
- forward_to
|
|
2494
2501
|
- alias
|
|
2502
|
+
- forward_to
|
|
2503
|
+
- email_forward_alias_id
|
|
2495
2504
|
title: EmailForwardAlias
|
|
2496
2505
|
type: object
|
|
2506
|
+
EmailForwardAliasCreate:
|
|
2507
|
+
properties:
|
|
2508
|
+
alias:
|
|
2509
|
+
title: Alias
|
|
2510
|
+
type: string
|
|
2511
|
+
forward_to:
|
|
2512
|
+
format: email
|
|
2513
|
+
title: Forward To
|
|
2514
|
+
type: string
|
|
2515
|
+
required:
|
|
2516
|
+
- alias
|
|
2517
|
+
- forward_to
|
|
2518
|
+
title: EmailForwardAliasCreate
|
|
2519
|
+
type: object
|
|
2497
2520
|
EmailForwardAliasUpdate:
|
|
2498
2521
|
properties:
|
|
2499
2522
|
forward_to:
|
|
@@ -2504,6 +2527,102 @@ components:
|
|
|
2504
2527
|
- forward_to
|
|
2505
2528
|
title: EmailForwardAliasUpdate
|
|
2506
2529
|
type: object
|
|
2530
|
+
EmailForwardCreate:
|
|
2531
|
+
properties:
|
|
2532
|
+
aliases:
|
|
2533
|
+
default: []
|
|
2534
|
+
items:
|
|
2535
|
+
$ref: '#/components/schemas/EmailForwardAliasCreate'
|
|
2536
|
+
title: Aliases
|
|
2537
|
+
type: array
|
|
2538
|
+
enabled:
|
|
2539
|
+
default: false
|
|
2540
|
+
title: Enabled
|
|
2541
|
+
type: boolean
|
|
2542
|
+
hostname:
|
|
2543
|
+
title: Hostname
|
|
2544
|
+
type: string
|
|
2545
|
+
required:
|
|
2546
|
+
- hostname
|
|
2547
|
+
title: EmailForwardCreate
|
|
2548
|
+
type: object
|
|
2549
|
+
EmailForwardResponse:
|
|
2550
|
+
properties:
|
|
2551
|
+
aliases:
|
|
2552
|
+
items:
|
|
2553
|
+
$ref: '#/components/schemas/EmailForwardAlias'
|
|
2554
|
+
title: Aliases
|
|
2555
|
+
type: array
|
|
2556
|
+
created_on:
|
|
2557
|
+
format: date-time
|
|
2558
|
+
title: Created On
|
|
2559
|
+
type: string
|
|
2560
|
+
email_forward_id:
|
|
2561
|
+
examples:
|
|
2562
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
2563
|
+
format: typeid
|
|
2564
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
2565
|
+
title: Email Forward Id
|
|
2566
|
+
type: string
|
|
2567
|
+
x-typeid-prefix: email_forward
|
|
2568
|
+
enabled:
|
|
2569
|
+
title: Enabled
|
|
2570
|
+
type: boolean
|
|
2571
|
+
hostname:
|
|
2572
|
+
title: Hostname
|
|
2573
|
+
type: string
|
|
2574
|
+
updated_on:
|
|
2575
|
+
format: date-time
|
|
2576
|
+
title: Updated On
|
|
2577
|
+
type: string
|
|
2578
|
+
required:
|
|
2579
|
+
- email_forward_id
|
|
2580
|
+
- hostname
|
|
2581
|
+
- enabled
|
|
2582
|
+
- aliases
|
|
2583
|
+
- created_on
|
|
2584
|
+
- updated_on
|
|
2585
|
+
title: EmailForwardResponse
|
|
2586
|
+
type: object
|
|
2587
|
+
EmailForwardSortField:
|
|
2588
|
+
enum:
|
|
2589
|
+
- hostname
|
|
2590
|
+
- enabled
|
|
2591
|
+
- created_on
|
|
2592
|
+
- updated_on
|
|
2593
|
+
title: EmailForwardSortField
|
|
2594
|
+
type: string
|
|
2595
|
+
EmailForwardZone:
|
|
2596
|
+
properties:
|
|
2597
|
+
email_forwards:
|
|
2598
|
+
items:
|
|
2599
|
+
$ref: '#/components/schemas/EmailForwardResponse'
|
|
2600
|
+
title: Email Forwards
|
|
2601
|
+
type: array
|
|
2602
|
+
zone_id:
|
|
2603
|
+
examples:
|
|
2604
|
+
- zone_01h45ytscbebyvny4gc8cr8ma2
|
|
2605
|
+
format: typeid
|
|
2606
|
+
pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
2607
|
+
title: Zone Id
|
|
2608
|
+
type: string
|
|
2609
|
+
x-typeid-prefix: zone
|
|
2610
|
+
zone_name:
|
|
2611
|
+
title: Zone Name
|
|
2612
|
+
type: string
|
|
2613
|
+
required:
|
|
2614
|
+
- zone_id
|
|
2615
|
+
- zone_name
|
|
2616
|
+
- email_forwards
|
|
2617
|
+
title: EmailForwardZone
|
|
2618
|
+
type: object
|
|
2619
|
+
EmailForwardZoneSortField:
|
|
2620
|
+
enum:
|
|
2621
|
+
- name
|
|
2622
|
+
- created_on
|
|
2623
|
+
- updated_on
|
|
2624
|
+
title: EmailForwardZoneSortField
|
|
2625
|
+
type: string
|
|
2507
2626
|
EmailVerificationStatus:
|
|
2508
2627
|
enum:
|
|
2509
2628
|
- verified
|
|
@@ -4058,19 +4177,33 @@ components:
|
|
|
4058
4177
|
- pagination
|
|
4059
4178
|
title: Pagination[DomainResponse]
|
|
4060
4179
|
type: object
|
|
4061
|
-
|
|
4180
|
+
Pagination_EmailForwardResponse_:
|
|
4062
4181
|
properties:
|
|
4063
4182
|
pagination:
|
|
4064
4183
|
$ref: '#/components/schemas/PaginationMetadata'
|
|
4065
4184
|
results:
|
|
4066
4185
|
items:
|
|
4067
|
-
$ref: '#/components/schemas/
|
|
4186
|
+
$ref: '#/components/schemas/EmailForwardResponse'
|
|
4187
|
+
title: Results
|
|
4188
|
+
type: array
|
|
4189
|
+
required:
|
|
4190
|
+
- results
|
|
4191
|
+
- pagination
|
|
4192
|
+
title: Pagination[EmailForwardResponse]
|
|
4193
|
+
type: object
|
|
4194
|
+
Pagination_EmailForwardZone_:
|
|
4195
|
+
properties:
|
|
4196
|
+
pagination:
|
|
4197
|
+
$ref: '#/components/schemas/PaginationMetadata'
|
|
4198
|
+
results:
|
|
4199
|
+
items:
|
|
4200
|
+
$ref: '#/components/schemas/EmailForwardZone'
|
|
4068
4201
|
title: Results
|
|
4069
4202
|
type: array
|
|
4070
4203
|
required:
|
|
4071
4204
|
- results
|
|
4072
4205
|
- pagination
|
|
4073
|
-
title: Pagination[
|
|
4206
|
+
title: Pagination[EmailForwardZone]
|
|
4074
4207
|
type: object
|
|
4075
4208
|
Pagination_EventResponse_:
|
|
4076
4209
|
properties:
|
|
@@ -4227,6 +4360,7 @@ components:
|
|
|
4227
4360
|
- manage_opusdns_api_keys
|
|
4228
4361
|
- manage_products
|
|
4229
4362
|
- manage_reseller
|
|
4363
|
+
- manage_sub_zones
|
|
4230
4364
|
- manage_users
|
|
4231
4365
|
- manage_user_relations
|
|
4232
4366
|
- plan_manager
|
|
@@ -5629,7 +5763,7 @@ info:
|
|
|
5629
5763
|
'
|
|
5630
5764
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5631
5765
|
title: OpusDNS API
|
|
5632
|
-
version: 2025-12-
|
|
5766
|
+
version: 2025-12-05-091638
|
|
5633
5767
|
x-logo:
|
|
5634
5768
|
altText: OpusDNS API Reference
|
|
5635
5769
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -7407,6 +7541,90 @@ paths:
|
|
|
7407
7541
|
summary: List domain forwards by zone
|
|
7408
7542
|
tags:
|
|
7409
7543
|
- dns
|
|
7544
|
+
/v1/dns/email-forwards:
|
|
7545
|
+
get:
|
|
7546
|
+
description: Retrieves a paginated list of email forwards grouped by DNS zones.
|
|
7547
|
+
operationId: list_email_forwards_by_zone_v1_dns_email_forwards_get
|
|
7548
|
+
parameters:
|
|
7549
|
+
- in: query
|
|
7550
|
+
name: search
|
|
7551
|
+
required: false
|
|
7552
|
+
schema:
|
|
7553
|
+
anyOf:
|
|
7554
|
+
- type: string
|
|
7555
|
+
- type: 'null'
|
|
7556
|
+
title: Search
|
|
7557
|
+
- in: query
|
|
7558
|
+
name: sort_by
|
|
7559
|
+
required: false
|
|
7560
|
+
schema:
|
|
7561
|
+
$ref: '#/components/schemas/EmailForwardZoneSortField'
|
|
7562
|
+
default: created_on
|
|
7563
|
+
- in: query
|
|
7564
|
+
name: sort_order
|
|
7565
|
+
required: false
|
|
7566
|
+
schema:
|
|
7567
|
+
$ref: '#/components/schemas/SortOrder'
|
|
7568
|
+
default: desc
|
|
7569
|
+
- in: query
|
|
7570
|
+
name: page
|
|
7571
|
+
required: false
|
|
7572
|
+
schema:
|
|
7573
|
+
default: 1
|
|
7574
|
+
minimum: 1
|
|
7575
|
+
title: Page
|
|
7576
|
+
type: integer
|
|
7577
|
+
- in: query
|
|
7578
|
+
name: page_size
|
|
7579
|
+
required: false
|
|
7580
|
+
schema:
|
|
7581
|
+
default: 10
|
|
7582
|
+
maximum: 1000
|
|
7583
|
+
minimum: 1
|
|
7584
|
+
title: Page Size
|
|
7585
|
+
type: integer
|
|
7586
|
+
responses:
|
|
7587
|
+
'200':
|
|
7588
|
+
content:
|
|
7589
|
+
application/json:
|
|
7590
|
+
schema:
|
|
7591
|
+
$ref: '#/components/schemas/Pagination_EmailForwardZone_'
|
|
7592
|
+
description: Successful Response
|
|
7593
|
+
'401':
|
|
7594
|
+
content:
|
|
7595
|
+
application/problem+json:
|
|
7596
|
+
example:
|
|
7597
|
+
code: ERROR_AUTHENTICATION
|
|
7598
|
+
detail: Additional error context.
|
|
7599
|
+
status: 401
|
|
7600
|
+
title: Authentication Error
|
|
7601
|
+
type: authentication
|
|
7602
|
+
schema:
|
|
7603
|
+
$ref: '#/components/schemas/Problem'
|
|
7604
|
+
description: Unauthorized
|
|
7605
|
+
'403':
|
|
7606
|
+
content:
|
|
7607
|
+
application/problem+json:
|
|
7608
|
+
example:
|
|
7609
|
+
code: ERROR_PERMISSION_DENIED
|
|
7610
|
+
detail: Insufficient permissions to perform this action
|
|
7611
|
+
status: 403
|
|
7612
|
+
title: Permission Denied
|
|
7613
|
+
type: permission-denied
|
|
7614
|
+
schema:
|
|
7615
|
+
$ref: '#/components/schemas/Problem'
|
|
7616
|
+
description: Forbidden
|
|
7617
|
+
'422':
|
|
7618
|
+
content:
|
|
7619
|
+
application/problem+json:
|
|
7620
|
+
schema:
|
|
7621
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
7622
|
+
description: Validation Error
|
|
7623
|
+
security:
|
|
7624
|
+
- OAuth2PasswordBearer: []
|
|
7625
|
+
summary: List email forwards by zone
|
|
7626
|
+
tags:
|
|
7627
|
+
- dns
|
|
7410
7628
|
/v1/dns/summary:
|
|
7411
7629
|
get:
|
|
7412
7630
|
operationId: get_zones_summary_v1_dns_summary_get
|
|
@@ -7472,88 +7690,9 @@ paths:
|
|
|
7472
7690
|
'200':
|
|
7473
7691
|
content:
|
|
7474
7692
|
application/json:
|
|
7475
|
-
examples:
|
|
7476
|
-
basic_zone:
|
|
7477
|
-
description: A newly created zone with only SOA and NS records
|
|
7478
|
-
summary: Basic zone with default records
|
|
7479
|
-
value:
|
|
7480
|
-
created_on: '2025-11-18T12:43:35Z'
|
|
7481
|
-
dnssec_status: disabled
|
|
7482
|
-
domain_parts:
|
|
7483
|
-
domain: example
|
|
7484
|
-
subdomain: ''
|
|
7485
|
-
suffix: com
|
|
7486
|
-
name: example.com.
|
|
7487
|
-
rrsets:
|
|
7488
|
-
- name: example.com.
|
|
7489
|
-
records:
|
|
7490
|
-
- rdata: ns1.opusdns.com. hostmaster.opusdns.com. 2025111801
|
|
7491
|
-
10800 3600 604800 300
|
|
7492
|
-
ttl: 3600
|
|
7493
|
-
type: SOA
|
|
7494
|
-
- name: example.com.
|
|
7495
|
-
records:
|
|
7496
|
-
- rdata: ns1.opusdns.com.
|
|
7497
|
-
- rdata: ns2.opusdns.net.
|
|
7498
|
-
ttl: 3600
|
|
7499
|
-
type: NS
|
|
7500
|
-
updated_on: '2025-11-18T12:43:35Z'
|
|
7501
|
-
zone_with_records:
|
|
7502
|
-
description: A fully configured zone with A, CNAME, MX, TXT records
|
|
7503
|
-
and DNSSEC enabled
|
|
7504
|
-
summary: Zone with custom records and DNSSEC
|
|
7505
|
-
value:
|
|
7506
|
-
created_on: '2025-11-15T10:30:00Z'
|
|
7507
|
-
dnssec_status: enabled
|
|
7508
|
-
domain_parts:
|
|
7509
|
-
domain: example
|
|
7510
|
-
subdomain: ''
|
|
7511
|
-
suffix: com
|
|
7512
|
-
name: example.com.
|
|
7513
|
-
rrsets:
|
|
7514
|
-
- name: example.com.
|
|
7515
|
-
records:
|
|
7516
|
-
- rdata: ns1.opusdns.com. hostmaster.opusdns.com. 2025111701
|
|
7517
|
-
10800 3600 604800 300
|
|
7518
|
-
ttl: 3600
|
|
7519
|
-
type: SOA
|
|
7520
|
-
- name: example.com.
|
|
7521
|
-
records:
|
|
7522
|
-
- rdata: ns1.opusdns.com.
|
|
7523
|
-
- rdata: ns2.opusdns.com.
|
|
7524
|
-
ttl: 3600
|
|
7525
|
-
type: NS
|
|
7526
|
-
- name: example.com.
|
|
7527
|
-
records:
|
|
7528
|
-
- rdata: 203.0.113.10
|
|
7529
|
-
ttl: 300
|
|
7530
|
-
type: A
|
|
7531
|
-
- name: www.example.com.
|
|
7532
|
-
records:
|
|
7533
|
-
- rdata: example.com.
|
|
7534
|
-
ttl: 300
|
|
7535
|
-
type: CNAME
|
|
7536
|
-
- name: example.com.
|
|
7537
|
-
records:
|
|
7538
|
-
- rdata: 10 mail.example.com.
|
|
7539
|
-
- rdata: 20 backup-mail.example.com.
|
|
7540
|
-
ttl: 300
|
|
7541
|
-
type: MX
|
|
7542
|
-
- name: example.com.
|
|
7543
|
-
records:
|
|
7544
|
-
- rdata: '"v=spf1 include:_spf.google.com ~all"'
|
|
7545
|
-
ttl: 300
|
|
7546
|
-
type: TXT
|
|
7547
|
-
- name: example.com.
|
|
7548
|
-
records:
|
|
7549
|
-
- rdata: 256 3 13 4epAMhnUgbFbAmKI2zbTXXFHGlVeHamiWLPdwJ8ehE9NgmvDNraqYF/0YdDcoc2elyelvi72KJyQfIR02axEeQ==
|
|
7550
|
-
- rdata: 257 3 13 Wx1Wk8Sl+PyanAWPYsCPw9qFv2Nv0U/MXoJGgpmdqgbLgtvPlVM1/66j/MFTOjk4ONGKGZoWbZ86ud18lWvacw==
|
|
7551
|
-
ttl: 300
|
|
7552
|
-
type: DNSKEY
|
|
7553
|
-
updated_on: '2025-11-17T14:20:00Z'
|
|
7554
7693
|
schema:
|
|
7555
7694
|
$ref: '#/components/schemas/DnsZoneResponse'
|
|
7556
|
-
description:
|
|
7695
|
+
description: Successful Response
|
|
7557
7696
|
'422':
|
|
7558
7697
|
content:
|
|
7559
7698
|
application/problem+json:
|
|
@@ -7817,6 +7956,62 @@ paths:
|
|
|
7817
7956
|
summary: List domain forwards for a zone
|
|
7818
7957
|
tags:
|
|
7819
7958
|
- dns
|
|
7959
|
+
/v1/dns/{zone_name}/email-forwards:
|
|
7960
|
+
get:
|
|
7961
|
+
description: Retrieves all email forwards configured for the specified DNS zone,
|
|
7962
|
+
including subdomains and all aliases.
|
|
7963
|
+
operationId: list_zone_email_forwards_v1_dns__zone_name__email_forwards_get
|
|
7964
|
+
parameters:
|
|
7965
|
+
- description: DNS zone name (trailing dot optional)
|
|
7966
|
+
in: path
|
|
7967
|
+
name: zone_name
|
|
7968
|
+
required: true
|
|
7969
|
+
schema:
|
|
7970
|
+
description: DNS zone name (trailing dot optional)
|
|
7971
|
+
title: Zone Name
|
|
7972
|
+
type: string
|
|
7973
|
+
responses:
|
|
7974
|
+
'200':
|
|
7975
|
+
content:
|
|
7976
|
+
application/json:
|
|
7977
|
+
schema:
|
|
7978
|
+
$ref: '#/components/schemas/EmailForwardZone'
|
|
7979
|
+
description: Successful Response
|
|
7980
|
+
'401':
|
|
7981
|
+
content:
|
|
7982
|
+
application/problem+json:
|
|
7983
|
+
example:
|
|
7984
|
+
code: ERROR_AUTHENTICATION
|
|
7985
|
+
detail: Additional error context.
|
|
7986
|
+
status: 401
|
|
7987
|
+
title: Authentication Error
|
|
7988
|
+
type: authentication
|
|
7989
|
+
schema:
|
|
7990
|
+
$ref: '#/components/schemas/Problem'
|
|
7991
|
+
description: Unauthorized
|
|
7992
|
+
'403':
|
|
7993
|
+
content:
|
|
7994
|
+
application/problem+json:
|
|
7995
|
+
example:
|
|
7996
|
+
code: ERROR_PERMISSION_DENIED
|
|
7997
|
+
detail: Insufficient permissions to perform this action
|
|
7998
|
+
status: 403
|
|
7999
|
+
title: Permission Denied
|
|
8000
|
+
type: permission-denied
|
|
8001
|
+
schema:
|
|
8002
|
+
$ref: '#/components/schemas/Problem'
|
|
8003
|
+
description: Forbidden
|
|
8004
|
+
'422':
|
|
8005
|
+
content:
|
|
8006
|
+
application/problem+json:
|
|
8007
|
+
schema:
|
|
8008
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
8009
|
+
description: Validation Error
|
|
8010
|
+
security:
|
|
8011
|
+
- OAuth2PasswordBearer: []
|
|
8012
|
+
summary: List email forwards for a zone
|
|
8013
|
+
tags:
|
|
8014
|
+
- dns
|
|
7820
8015
|
/v1/dns/{zone_name}/records:
|
|
7821
8016
|
patch:
|
|
7822
8017
|
operationId: patch_zone_records_v1_dns__zone_name__records_patch
|
|
@@ -10265,43 +10460,39 @@ paths:
|
|
|
10265
10460
|
summary: Cancel a domain transfer
|
|
10266
10461
|
tags:
|
|
10267
10462
|
- domain
|
|
10268
|
-
/v1/email-forwards
|
|
10269
|
-
|
|
10270
|
-
|
|
10463
|
+
/v1/email-forwards:
|
|
10464
|
+
get:
|
|
10465
|
+
description: Retrieves a paginated list of all email forwards for the organization.
|
|
10466
|
+
operationId: list_email_forwards_v1_email_forwards_get
|
|
10271
10467
|
parameters:
|
|
10272
|
-
-
|
|
10273
|
-
|
|
10274
|
-
|
|
10275
|
-
required: true
|
|
10468
|
+
- in: query
|
|
10469
|
+
name: search
|
|
10470
|
+
required: false
|
|
10276
10471
|
schema:
|
|
10277
|
-
|
|
10278
|
-
|
|
10279
|
-
type:
|
|
10280
|
-
|
|
10281
|
-
|
|
10282
|
-
|
|
10283
|
-
|
|
10284
|
-
content:
|
|
10285
|
-
application/problem+json:
|
|
10286
|
-
schema:
|
|
10287
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
10288
|
-
description: Validation Error
|
|
10289
|
-
security:
|
|
10290
|
-
- OAuth2PasswordBearer: []
|
|
10291
|
-
summary: Delete Email Forward Aliases
|
|
10292
|
-
tags:
|
|
10293
|
-
- email_forward
|
|
10294
|
-
get:
|
|
10295
|
-
operationId: get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get
|
|
10296
|
-
parameters:
|
|
10297
|
-
- description: DNS zone name (trailing dot optional)
|
|
10298
|
-
in: path
|
|
10299
|
-
name: zone_name
|
|
10300
|
-
required: true
|
|
10472
|
+
anyOf:
|
|
10473
|
+
- type: string
|
|
10474
|
+
- type: 'null'
|
|
10475
|
+
title: Search
|
|
10476
|
+
- in: query
|
|
10477
|
+
name: enabled
|
|
10478
|
+
required: false
|
|
10301
10479
|
schema:
|
|
10302
|
-
|
|
10303
|
-
|
|
10304
|
-
type:
|
|
10480
|
+
anyOf:
|
|
10481
|
+
- type: boolean
|
|
10482
|
+
- type: 'null'
|
|
10483
|
+
title: Enabled
|
|
10484
|
+
- in: query
|
|
10485
|
+
name: sort_by
|
|
10486
|
+
required: false
|
|
10487
|
+
schema:
|
|
10488
|
+
$ref: '#/components/schemas/EmailForwardSortField'
|
|
10489
|
+
default: created_on
|
|
10490
|
+
- in: query
|
|
10491
|
+
name: sort_order
|
|
10492
|
+
required: false
|
|
10493
|
+
schema:
|
|
10494
|
+
$ref: '#/components/schemas/SortOrder'
|
|
10495
|
+
default: desc
|
|
10305
10496
|
- in: query
|
|
10306
10497
|
name: page
|
|
10307
10498
|
required: false
|
|
@@ -10324,8 +10515,32 @@ paths:
|
|
|
10324
10515
|
content:
|
|
10325
10516
|
application/json:
|
|
10326
10517
|
schema:
|
|
10327
|
-
$ref: '#/components/schemas/
|
|
10518
|
+
$ref: '#/components/schemas/Pagination_EmailForwardResponse_'
|
|
10328
10519
|
description: Successful Response
|
|
10520
|
+
'401':
|
|
10521
|
+
content:
|
|
10522
|
+
application/problem+json:
|
|
10523
|
+
example:
|
|
10524
|
+
code: ERROR_AUTHENTICATION
|
|
10525
|
+
detail: Additional error context.
|
|
10526
|
+
status: 401
|
|
10527
|
+
title: Authentication Error
|
|
10528
|
+
type: authentication
|
|
10529
|
+
schema:
|
|
10530
|
+
$ref: '#/components/schemas/Problem'
|
|
10531
|
+
description: Unauthorized
|
|
10532
|
+
'403':
|
|
10533
|
+
content:
|
|
10534
|
+
application/problem+json:
|
|
10535
|
+
example:
|
|
10536
|
+
code: ERROR_PERMISSION_DENIED
|
|
10537
|
+
detail: Insufficient permissions to perform this action
|
|
10538
|
+
status: 403
|
|
10539
|
+
title: Permission Denied
|
|
10540
|
+
type: permission-denied
|
|
10541
|
+
schema:
|
|
10542
|
+
$ref: '#/components/schemas/Problem'
|
|
10543
|
+
description: Forbidden
|
|
10329
10544
|
'422':
|
|
10330
10545
|
content:
|
|
10331
10546
|
application/problem+json:
|
|
@@ -10334,29 +10549,76 @@ paths:
|
|
|
10334
10549
|
description: Validation Error
|
|
10335
10550
|
security:
|
|
10336
10551
|
- OAuth2PasswordBearer: []
|
|
10337
|
-
summary:
|
|
10552
|
+
summary: List all email forwards
|
|
10338
10553
|
tags:
|
|
10339
10554
|
- email_forward
|
|
10340
10555
|
post:
|
|
10341
|
-
|
|
10342
|
-
|
|
10343
|
-
|
|
10344
|
-
|
|
10345
|
-
name: zone_name
|
|
10346
|
-
required: true
|
|
10347
|
-
schema:
|
|
10348
|
-
description: DNS zone name (trailing dot optional)
|
|
10349
|
-
title: Zone Name
|
|
10350
|
-
type: string
|
|
10556
|
+
description: 'Creates an email forward configuration with optional aliases.
|
|
10557
|
+
Can be created enabled or disabled (default: disabled). Includes created_on
|
|
10558
|
+
and updated_on timestamps.'
|
|
10559
|
+
operationId: create_email_forward_v1_email_forwards_post
|
|
10351
10560
|
requestBody:
|
|
10352
10561
|
content:
|
|
10353
10562
|
application/json:
|
|
10354
10563
|
schema:
|
|
10355
|
-
$ref: '#/components/schemas/
|
|
10564
|
+
$ref: '#/components/schemas/EmailForwardCreate'
|
|
10356
10565
|
required: true
|
|
10357
10566
|
responses:
|
|
10358
10567
|
'201':
|
|
10568
|
+
content:
|
|
10569
|
+
application/json:
|
|
10570
|
+
schema:
|
|
10571
|
+
$ref: '#/components/schemas/EmailForwardResponse'
|
|
10359
10572
|
description: Successful Response
|
|
10573
|
+
'401':
|
|
10574
|
+
content:
|
|
10575
|
+
application/problem+json:
|
|
10576
|
+
example:
|
|
10577
|
+
code: ERROR_AUTHENTICATION
|
|
10578
|
+
detail: Additional error context.
|
|
10579
|
+
status: 401
|
|
10580
|
+
title: Authentication Error
|
|
10581
|
+
type: authentication
|
|
10582
|
+
schema:
|
|
10583
|
+
$ref: '#/components/schemas/Problem'
|
|
10584
|
+
description: Unauthorized
|
|
10585
|
+
'403':
|
|
10586
|
+
content:
|
|
10587
|
+
application/problem+json:
|
|
10588
|
+
example:
|
|
10589
|
+
code: ERROR_PERMISSION_DENIED
|
|
10590
|
+
detail: Insufficient permissions to perform this action
|
|
10591
|
+
status: 403
|
|
10592
|
+
title: Permission Denied
|
|
10593
|
+
type: permission-denied
|
|
10594
|
+
schema:
|
|
10595
|
+
$ref: '#/components/schemas/Problem'
|
|
10596
|
+
description: Forbidden
|
|
10597
|
+
'404':
|
|
10598
|
+
content:
|
|
10599
|
+
application/problem+json:
|
|
10600
|
+
example:
|
|
10601
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
10602
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
10603
|
+
status: 404
|
|
10604
|
+
title: Email Forward Error
|
|
10605
|
+
type: email-forward-not-found
|
|
10606
|
+
schema:
|
|
10607
|
+
$ref: '#/components/schemas/Problem'
|
|
10608
|
+
description: Not Found
|
|
10609
|
+
'409':
|
|
10610
|
+
content:
|
|
10611
|
+
application/problem+json:
|
|
10612
|
+
example:
|
|
10613
|
+
code: ERROR_EMAIL_FORWARD_DOMAIN_ALREADY_ENABLED
|
|
10614
|
+
detail: 'Email forward already exists for hostname: Additional error
|
|
10615
|
+
context.'
|
|
10616
|
+
status: 409
|
|
10617
|
+
title: Email Forward Error
|
|
10618
|
+
type: email-forward-already-exists
|
|
10619
|
+
schema:
|
|
10620
|
+
$ref: '#/components/schemas/Problem'
|
|
10621
|
+
description: Conflict
|
|
10360
10622
|
'422':
|
|
10361
10623
|
content:
|
|
10362
10624
|
application/problem+json:
|
|
@@ -10365,30 +10627,54 @@ paths:
|
|
|
10365
10627
|
description: Validation Error
|
|
10366
10628
|
security:
|
|
10367
10629
|
- OAuth2PasswordBearer: []
|
|
10368
|
-
summary: Create
|
|
10630
|
+
summary: Create email forward configuration
|
|
10369
10631
|
tags:
|
|
10370
10632
|
- email_forward
|
|
10371
|
-
/v1/email-forwards/{
|
|
10633
|
+
/v1/email-forwards/{email_forward_id}:
|
|
10372
10634
|
delete:
|
|
10373
|
-
|
|
10635
|
+
description: Permanently deletes the email forward configuration including all
|
|
10636
|
+
aliases. If enabled, automatically disables first (removes DNS records and
|
|
10637
|
+
unregisters from ImprovMX).
|
|
10638
|
+
operationId: delete_email_forward_v1_email_forwards__email_forward_id__delete
|
|
10374
10639
|
parameters:
|
|
10375
10640
|
- in: path
|
|
10376
|
-
name:
|
|
10641
|
+
name: email_forward_id
|
|
10377
10642
|
required: true
|
|
10378
10643
|
schema:
|
|
10379
|
-
|
|
10380
|
-
|
|
10381
|
-
|
|
10382
|
-
|
|
10383
|
-
|
|
10384
|
-
required: true
|
|
10385
|
-
schema:
|
|
10386
|
-
description: DNS zone name (trailing dot optional)
|
|
10387
|
-
title: Zone Name
|
|
10644
|
+
examples:
|
|
10645
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
10646
|
+
format: typeid
|
|
10647
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10648
|
+
title: Email Forward Id
|
|
10388
10649
|
type: string
|
|
10650
|
+
x-typeid-prefix: email_forward
|
|
10389
10651
|
responses:
|
|
10390
10652
|
'204':
|
|
10391
10653
|
description: Successful Response
|
|
10654
|
+
'401':
|
|
10655
|
+
content:
|
|
10656
|
+
application/problem+json:
|
|
10657
|
+
example:
|
|
10658
|
+
code: ERROR_AUTHENTICATION
|
|
10659
|
+
detail: Additional error context.
|
|
10660
|
+
status: 401
|
|
10661
|
+
title: Authentication Error
|
|
10662
|
+
type: authentication
|
|
10663
|
+
schema:
|
|
10664
|
+
$ref: '#/components/schemas/Problem'
|
|
10665
|
+
description: Unauthorized
|
|
10666
|
+
'403':
|
|
10667
|
+
content:
|
|
10668
|
+
application/problem+json:
|
|
10669
|
+
example:
|
|
10670
|
+
code: ERROR_PERMISSION_DENIED
|
|
10671
|
+
detail: Insufficient permissions to perform this action
|
|
10672
|
+
status: 403
|
|
10673
|
+
title: Permission Denied
|
|
10674
|
+
type: permission-denied
|
|
10675
|
+
schema:
|
|
10676
|
+
$ref: '#/components/schemas/Problem'
|
|
10677
|
+
description: Forbidden
|
|
10392
10678
|
'422':
|
|
10393
10679
|
content:
|
|
10394
10680
|
application/problem+json:
|
|
@@ -10397,33 +10683,233 @@ paths:
|
|
|
10397
10683
|
description: Validation Error
|
|
10398
10684
|
security:
|
|
10399
10685
|
- OAuth2PasswordBearer: []
|
|
10400
|
-
summary: Delete
|
|
10686
|
+
summary: Delete email forward configuration
|
|
10401
10687
|
tags:
|
|
10402
10688
|
- email_forward
|
|
10403
10689
|
get:
|
|
10404
|
-
|
|
10690
|
+
description: Retrieves the email forward configuration for the specified zone
|
|
10691
|
+
including all aliases
|
|
10692
|
+
operationId: get_email_forward_v1_email_forwards__email_forward_id__get
|
|
10405
10693
|
parameters:
|
|
10406
10694
|
- in: path
|
|
10407
|
-
name:
|
|
10695
|
+
name: email_forward_id
|
|
10408
10696
|
required: true
|
|
10409
10697
|
schema:
|
|
10410
|
-
|
|
10698
|
+
examples:
|
|
10699
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
10700
|
+
format: typeid
|
|
10701
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10702
|
+
title: Email Forward Id
|
|
10411
10703
|
type: string
|
|
10412
|
-
|
|
10413
|
-
|
|
10414
|
-
|
|
10704
|
+
x-typeid-prefix: email_forward
|
|
10705
|
+
responses:
|
|
10706
|
+
'200':
|
|
10707
|
+
content:
|
|
10708
|
+
application/json:
|
|
10709
|
+
schema:
|
|
10710
|
+
$ref: '#/components/schemas/EmailForwardResponse'
|
|
10711
|
+
description: Successful Response
|
|
10712
|
+
'401':
|
|
10713
|
+
content:
|
|
10714
|
+
application/problem+json:
|
|
10715
|
+
example:
|
|
10716
|
+
code: ERROR_AUTHENTICATION
|
|
10717
|
+
detail: Additional error context.
|
|
10718
|
+
status: 401
|
|
10719
|
+
title: Authentication Error
|
|
10720
|
+
type: authentication
|
|
10721
|
+
schema:
|
|
10722
|
+
$ref: '#/components/schemas/Problem'
|
|
10723
|
+
description: Unauthorized
|
|
10724
|
+
'403':
|
|
10725
|
+
content:
|
|
10726
|
+
application/problem+json:
|
|
10727
|
+
example:
|
|
10728
|
+
code: ERROR_PERMISSION_DENIED
|
|
10729
|
+
detail: Insufficient permissions to perform this action
|
|
10730
|
+
status: 403
|
|
10731
|
+
title: Permission Denied
|
|
10732
|
+
type: permission-denied
|
|
10733
|
+
schema:
|
|
10734
|
+
$ref: '#/components/schemas/Problem'
|
|
10735
|
+
description: Forbidden
|
|
10736
|
+
'404':
|
|
10737
|
+
content:
|
|
10738
|
+
application/problem+json:
|
|
10739
|
+
example:
|
|
10740
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
10741
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
10742
|
+
status: 404
|
|
10743
|
+
title: Email Forward Error
|
|
10744
|
+
type: email-forward-not-found
|
|
10745
|
+
schema:
|
|
10746
|
+
$ref: '#/components/schemas/Problem'
|
|
10747
|
+
description: Not Found
|
|
10748
|
+
'422':
|
|
10749
|
+
content:
|
|
10750
|
+
application/problem+json:
|
|
10751
|
+
schema:
|
|
10752
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10753
|
+
description: Validation Error
|
|
10754
|
+
security:
|
|
10755
|
+
- OAuth2PasswordBearer: []
|
|
10756
|
+
summary: Get email forward configuration
|
|
10757
|
+
tags:
|
|
10758
|
+
- email_forward
|
|
10759
|
+
/v1/email-forwards/{email_forward_id}/aliases:
|
|
10760
|
+
post:
|
|
10761
|
+
description: Creates a new email forward alias for the specified hostname.
|
|
10762
|
+
operationId: create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post
|
|
10763
|
+
parameters:
|
|
10764
|
+
- in: path
|
|
10765
|
+
name: email_forward_id
|
|
10415
10766
|
required: true
|
|
10416
10767
|
schema:
|
|
10417
|
-
|
|
10418
|
-
|
|
10768
|
+
examples:
|
|
10769
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
10770
|
+
format: typeid
|
|
10771
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10772
|
+
title: Email Forward Id
|
|
10419
10773
|
type: string
|
|
10774
|
+
x-typeid-prefix: email_forward
|
|
10775
|
+
requestBody:
|
|
10776
|
+
content:
|
|
10777
|
+
application/json:
|
|
10778
|
+
schema:
|
|
10779
|
+
$ref: '#/components/schemas/EmailForwardAliasCreate'
|
|
10780
|
+
required: true
|
|
10420
10781
|
responses:
|
|
10421
|
-
'
|
|
10782
|
+
'201':
|
|
10422
10783
|
content:
|
|
10423
10784
|
application/json:
|
|
10424
10785
|
schema:
|
|
10425
10786
|
$ref: '#/components/schemas/EmailForwardAlias'
|
|
10426
10787
|
description: Successful Response
|
|
10788
|
+
'401':
|
|
10789
|
+
content:
|
|
10790
|
+
application/problem+json:
|
|
10791
|
+
example:
|
|
10792
|
+
code: ERROR_AUTHENTICATION
|
|
10793
|
+
detail: Additional error context.
|
|
10794
|
+
status: 401
|
|
10795
|
+
title: Authentication Error
|
|
10796
|
+
type: authentication
|
|
10797
|
+
schema:
|
|
10798
|
+
$ref: '#/components/schemas/Problem'
|
|
10799
|
+
description: Unauthorized
|
|
10800
|
+
'403':
|
|
10801
|
+
content:
|
|
10802
|
+
application/problem+json:
|
|
10803
|
+
example:
|
|
10804
|
+
code: ERROR_PERMISSION_DENIED
|
|
10805
|
+
detail: Insufficient permissions to perform this action
|
|
10806
|
+
status: 403
|
|
10807
|
+
title: Permission Denied
|
|
10808
|
+
type: permission-denied
|
|
10809
|
+
schema:
|
|
10810
|
+
$ref: '#/components/schemas/Problem'
|
|
10811
|
+
description: Forbidden
|
|
10812
|
+
'404':
|
|
10813
|
+
content:
|
|
10814
|
+
application/problem+json:
|
|
10815
|
+
example:
|
|
10816
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
10817
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
10818
|
+
status: 404
|
|
10819
|
+
title: Email Forward Error
|
|
10820
|
+
type: email-forward-not-found
|
|
10821
|
+
schema:
|
|
10822
|
+
$ref: '#/components/schemas/Problem'
|
|
10823
|
+
description: Not Found
|
|
10824
|
+
'409':
|
|
10825
|
+
content:
|
|
10826
|
+
application/problem+json:
|
|
10827
|
+
example:
|
|
10828
|
+
code: ERROR_EMAIL_FORWARD_ALIAS_ALREADY_EXISTS
|
|
10829
|
+
detail: Additional error context.
|
|
10830
|
+
status: 409
|
|
10831
|
+
title: Email Forward Error
|
|
10832
|
+
type: email-forward-alias-already-exists
|
|
10833
|
+
schema:
|
|
10834
|
+
$ref: '#/components/schemas/Problem'
|
|
10835
|
+
description: Conflict
|
|
10836
|
+
'422':
|
|
10837
|
+
content:
|
|
10838
|
+
application/problem+json:
|
|
10839
|
+
schema:
|
|
10840
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10841
|
+
description: Validation Error
|
|
10842
|
+
security:
|
|
10843
|
+
- OAuth2PasswordBearer: []
|
|
10844
|
+
summary: Create email forward alias
|
|
10845
|
+
tags:
|
|
10846
|
+
- email_forward
|
|
10847
|
+
/v1/email-forwards/{email_forward_id}/aliases/{alias_id}:
|
|
10848
|
+
delete:
|
|
10849
|
+
description: Deletes a specific email forward alias for the specified zone
|
|
10850
|
+
operationId: delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete
|
|
10851
|
+
parameters:
|
|
10852
|
+
- in: path
|
|
10853
|
+
name: email_forward_id
|
|
10854
|
+
required: true
|
|
10855
|
+
schema:
|
|
10856
|
+
examples:
|
|
10857
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
10858
|
+
format: typeid
|
|
10859
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10860
|
+
title: Email Forward Id
|
|
10861
|
+
type: string
|
|
10862
|
+
x-typeid-prefix: email_forward
|
|
10863
|
+
- in: path
|
|
10864
|
+
name: alias_id
|
|
10865
|
+
required: true
|
|
10866
|
+
schema:
|
|
10867
|
+
examples:
|
|
10868
|
+
- email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
|
|
10869
|
+
format: typeid
|
|
10870
|
+
pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10871
|
+
title: Alias Id
|
|
10872
|
+
type: string
|
|
10873
|
+
x-typeid-prefix: email_forward_alias
|
|
10874
|
+
responses:
|
|
10875
|
+
'204':
|
|
10876
|
+
description: Successful Response
|
|
10877
|
+
'401':
|
|
10878
|
+
content:
|
|
10879
|
+
application/problem+json:
|
|
10880
|
+
example:
|
|
10881
|
+
code: ERROR_AUTHENTICATION
|
|
10882
|
+
detail: Additional error context.
|
|
10883
|
+
status: 401
|
|
10884
|
+
title: Authentication Error
|
|
10885
|
+
type: authentication
|
|
10886
|
+
schema:
|
|
10887
|
+
$ref: '#/components/schemas/Problem'
|
|
10888
|
+
description: Unauthorized
|
|
10889
|
+
'403':
|
|
10890
|
+
content:
|
|
10891
|
+
application/problem+json:
|
|
10892
|
+
example:
|
|
10893
|
+
code: ERROR_PERMISSION_DENIED
|
|
10894
|
+
detail: Insufficient permissions to perform this action
|
|
10895
|
+
status: 403
|
|
10896
|
+
title: Permission Denied
|
|
10897
|
+
type: permission-denied
|
|
10898
|
+
schema:
|
|
10899
|
+
$ref: '#/components/schemas/Problem'
|
|
10900
|
+
description: Forbidden
|
|
10901
|
+
'404':
|
|
10902
|
+
content:
|
|
10903
|
+
application/problem+json:
|
|
10904
|
+
example:
|
|
10905
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
10906
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
10907
|
+
status: 404
|
|
10908
|
+
title: Email Forward Error
|
|
10909
|
+
type: email-forward-not-found
|
|
10910
|
+
schema:
|
|
10911
|
+
$ref: '#/components/schemas/Problem'
|
|
10912
|
+
description: Not Found
|
|
10427
10913
|
'422':
|
|
10428
10914
|
content:
|
|
10429
10915
|
application/problem+json:
|
|
@@ -10432,26 +10918,35 @@ paths:
|
|
|
10432
10918
|
description: Validation Error
|
|
10433
10919
|
security:
|
|
10434
10920
|
- OAuth2PasswordBearer: []
|
|
10435
|
-
summary:
|
|
10921
|
+
summary: Delete email forward alias
|
|
10436
10922
|
tags:
|
|
10437
10923
|
- email_forward
|
|
10438
10924
|
put:
|
|
10439
|
-
|
|
10925
|
+
description: Updates the forward_to address for a specific email forward alias
|
|
10926
|
+
operationId: update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put
|
|
10440
10927
|
parameters:
|
|
10441
10928
|
- in: path
|
|
10442
|
-
name:
|
|
10929
|
+
name: email_forward_id
|
|
10443
10930
|
required: true
|
|
10444
10931
|
schema:
|
|
10445
|
-
|
|
10932
|
+
examples:
|
|
10933
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
10934
|
+
format: typeid
|
|
10935
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10936
|
+
title: Email Forward Id
|
|
10446
10937
|
type: string
|
|
10447
|
-
|
|
10448
|
-
|
|
10449
|
-
name:
|
|
10938
|
+
x-typeid-prefix: email_forward
|
|
10939
|
+
- in: path
|
|
10940
|
+
name: alias_id
|
|
10450
10941
|
required: true
|
|
10451
10942
|
schema:
|
|
10452
|
-
|
|
10453
|
-
|
|
10943
|
+
examples:
|
|
10944
|
+
- email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
|
|
10945
|
+
format: typeid
|
|
10946
|
+
pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10947
|
+
title: Alias Id
|
|
10454
10948
|
type: string
|
|
10949
|
+
x-typeid-prefix: email_forward_alias
|
|
10455
10950
|
requestBody:
|
|
10456
10951
|
content:
|
|
10457
10952
|
application/json:
|
|
@@ -10459,8 +10954,48 @@ paths:
|
|
|
10459
10954
|
$ref: '#/components/schemas/EmailForwardAliasUpdate'
|
|
10460
10955
|
required: true
|
|
10461
10956
|
responses:
|
|
10462
|
-
'
|
|
10957
|
+
'200':
|
|
10958
|
+
content:
|
|
10959
|
+
application/json:
|
|
10960
|
+
schema:
|
|
10961
|
+
$ref: '#/components/schemas/EmailForwardAlias'
|
|
10463
10962
|
description: Successful Response
|
|
10963
|
+
'401':
|
|
10964
|
+
content:
|
|
10965
|
+
application/problem+json:
|
|
10966
|
+
example:
|
|
10967
|
+
code: ERROR_AUTHENTICATION
|
|
10968
|
+
detail: Additional error context.
|
|
10969
|
+
status: 401
|
|
10970
|
+
title: Authentication Error
|
|
10971
|
+
type: authentication
|
|
10972
|
+
schema:
|
|
10973
|
+
$ref: '#/components/schemas/Problem'
|
|
10974
|
+
description: Unauthorized
|
|
10975
|
+
'403':
|
|
10976
|
+
content:
|
|
10977
|
+
application/problem+json:
|
|
10978
|
+
example:
|
|
10979
|
+
code: ERROR_PERMISSION_DENIED
|
|
10980
|
+
detail: Insufficient permissions to perform this action
|
|
10981
|
+
status: 403
|
|
10982
|
+
title: Permission Denied
|
|
10983
|
+
type: permission-denied
|
|
10984
|
+
schema:
|
|
10985
|
+
$ref: '#/components/schemas/Problem'
|
|
10986
|
+
description: Forbidden
|
|
10987
|
+
'404':
|
|
10988
|
+
content:
|
|
10989
|
+
application/problem+json:
|
|
10990
|
+
example:
|
|
10991
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
10992
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
10993
|
+
status: 404
|
|
10994
|
+
title: Email Forward Error
|
|
10995
|
+
type: email-forward-not-found
|
|
10996
|
+
schema:
|
|
10997
|
+
$ref: '#/components/schemas/Problem'
|
|
10998
|
+
description: Not Found
|
|
10464
10999
|
'422':
|
|
10465
11000
|
content:
|
|
10466
11001
|
application/problem+json:
|
|
@@ -10469,24 +11004,66 @@ paths:
|
|
|
10469
11004
|
description: Validation Error
|
|
10470
11005
|
security:
|
|
10471
11006
|
- OAuth2PasswordBearer: []
|
|
10472
|
-
summary: Update
|
|
11007
|
+
summary: Update email forward alias
|
|
10473
11008
|
tags:
|
|
10474
11009
|
- email_forward
|
|
10475
|
-
/v1/email-forwards/{
|
|
11010
|
+
/v1/email-forwards/{email_forward_id}/disable:
|
|
10476
11011
|
patch:
|
|
10477
|
-
|
|
11012
|
+
description: Disables email forwarding by removing MX and SPF DNS records and
|
|
11013
|
+
unregistering the domain from the email forward provider. The email forward
|
|
11014
|
+
configuration is preserved but disabled.
|
|
11015
|
+
operationId: disable_email_forward_v1_email_forwards__email_forward_id__disable_patch
|
|
10478
11016
|
parameters:
|
|
10479
|
-
-
|
|
10480
|
-
|
|
10481
|
-
name: zone_name
|
|
11017
|
+
- in: path
|
|
11018
|
+
name: email_forward_id
|
|
10482
11019
|
required: true
|
|
10483
11020
|
schema:
|
|
10484
|
-
|
|
10485
|
-
|
|
11021
|
+
examples:
|
|
11022
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
11023
|
+
format: typeid
|
|
11024
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11025
|
+
title: Email Forward Id
|
|
10486
11026
|
type: string
|
|
11027
|
+
x-typeid-prefix: email_forward
|
|
10487
11028
|
responses:
|
|
10488
11029
|
'204':
|
|
10489
11030
|
description: Successful Response
|
|
11031
|
+
'401':
|
|
11032
|
+
content:
|
|
11033
|
+
application/problem+json:
|
|
11034
|
+
example:
|
|
11035
|
+
code: ERROR_AUTHENTICATION
|
|
11036
|
+
detail: Additional error context.
|
|
11037
|
+
status: 401
|
|
11038
|
+
title: Authentication Error
|
|
11039
|
+
type: authentication
|
|
11040
|
+
schema:
|
|
11041
|
+
$ref: '#/components/schemas/Problem'
|
|
11042
|
+
description: Unauthorized
|
|
11043
|
+
'403':
|
|
11044
|
+
content:
|
|
11045
|
+
application/problem+json:
|
|
11046
|
+
example:
|
|
11047
|
+
code: ERROR_PERMISSION_DENIED
|
|
11048
|
+
detail: Insufficient permissions to perform this action
|
|
11049
|
+
status: 403
|
|
11050
|
+
title: Permission Denied
|
|
11051
|
+
type: permission-denied
|
|
11052
|
+
schema:
|
|
11053
|
+
$ref: '#/components/schemas/Problem'
|
|
11054
|
+
description: Forbidden
|
|
11055
|
+
'404':
|
|
11056
|
+
content:
|
|
11057
|
+
application/problem+json:
|
|
11058
|
+
example:
|
|
11059
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
11060
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
11061
|
+
status: 404
|
|
11062
|
+
title: Email Forward Error
|
|
11063
|
+
type: email-forward-not-found
|
|
11064
|
+
schema:
|
|
11065
|
+
$ref: '#/components/schemas/Problem'
|
|
11066
|
+
description: Not Found
|
|
10490
11067
|
'422':
|
|
10491
11068
|
content:
|
|
10492
11069
|
application/problem+json:
|
|
@@ -10495,31 +11072,65 @@ paths:
|
|
|
10495
11072
|
description: Validation Error
|
|
10496
11073
|
security:
|
|
10497
11074
|
- OAuth2PasswordBearer: []
|
|
10498
|
-
summary: Disable
|
|
11075
|
+
summary: Disable email forwarding
|
|
10499
11076
|
tags:
|
|
10500
11077
|
- email_forward
|
|
10501
|
-
/v1/email-forwards/{
|
|
11078
|
+
/v1/email-forwards/{email_forward_id}/enable:
|
|
10502
11079
|
patch:
|
|
10503
|
-
|
|
11080
|
+
description: Enables email forwarding by creating necessary MX and SPF DNS records
|
|
11081
|
+
and registering the domain with the email forward provider.
|
|
11082
|
+
operationId: enable_email_forward_v1_email_forwards__email_forward_id__enable_patch
|
|
10504
11083
|
parameters:
|
|
10505
|
-
-
|
|
10506
|
-
|
|
10507
|
-
name: zone_name
|
|
11084
|
+
- in: path
|
|
11085
|
+
name: email_forward_id
|
|
10508
11086
|
required: true
|
|
10509
11087
|
schema:
|
|
10510
|
-
|
|
10511
|
-
|
|
11088
|
+
examples:
|
|
11089
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
11090
|
+
format: typeid
|
|
11091
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11092
|
+
title: Email Forward Id
|
|
10512
11093
|
type: string
|
|
10513
|
-
|
|
10514
|
-
name: auto_create_zone
|
|
10515
|
-
required: false
|
|
10516
|
-
schema:
|
|
10517
|
-
default: false
|
|
10518
|
-
title: Auto Create Zone
|
|
10519
|
-
type: boolean
|
|
11094
|
+
x-typeid-prefix: email_forward
|
|
10520
11095
|
responses:
|
|
10521
11096
|
'204':
|
|
10522
11097
|
description: Successful Response
|
|
11098
|
+
'401':
|
|
11099
|
+
content:
|
|
11100
|
+
application/problem+json:
|
|
11101
|
+
example:
|
|
11102
|
+
code: ERROR_AUTHENTICATION
|
|
11103
|
+
detail: Additional error context.
|
|
11104
|
+
status: 401
|
|
11105
|
+
title: Authentication Error
|
|
11106
|
+
type: authentication
|
|
11107
|
+
schema:
|
|
11108
|
+
$ref: '#/components/schemas/Problem'
|
|
11109
|
+
description: Unauthorized
|
|
11110
|
+
'403':
|
|
11111
|
+
content:
|
|
11112
|
+
application/problem+json:
|
|
11113
|
+
example:
|
|
11114
|
+
code: ERROR_PERMISSION_DENIED
|
|
11115
|
+
detail: Insufficient permissions to perform this action
|
|
11116
|
+
status: 403
|
|
11117
|
+
title: Permission Denied
|
|
11118
|
+
type: permission-denied
|
|
11119
|
+
schema:
|
|
11120
|
+
$ref: '#/components/schemas/Problem'
|
|
11121
|
+
description: Forbidden
|
|
11122
|
+
'404':
|
|
11123
|
+
content:
|
|
11124
|
+
application/problem+json:
|
|
11125
|
+
example:
|
|
11126
|
+
code: ERROR_EMAIL_FORWARD_NOT_FOUND
|
|
11127
|
+
detail: 'Email forward not found for hostname: Additional error context.'
|
|
11128
|
+
status: 404
|
|
11129
|
+
title: Email Forward Error
|
|
11130
|
+
type: email-forward-not-found
|
|
11131
|
+
schema:
|
|
11132
|
+
$ref: '#/components/schemas/Problem'
|
|
11133
|
+
description: Not Found
|
|
10523
11134
|
'422':
|
|
10524
11135
|
content:
|
|
10525
11136
|
application/problem+json:
|
|
@@ -10528,7 +11139,7 @@ paths:
|
|
|
10528
11139
|
description: Validation Error
|
|
10529
11140
|
security:
|
|
10530
11141
|
- OAuth2PasswordBearer: []
|
|
10531
|
-
summary: Enable
|
|
11142
|
+
summary: Enable email forwarding
|
|
10532
11143
|
tags:
|
|
10533
11144
|
- email_forward
|
|
10534
11145
|
/v1/events:
|