Skip to content

Commit 3b83ce6

Browse files
futuregeraldbertvansteen
authored andcommitted
added all dns_zone and dns_record public endpoints
1 parent 29814e0 commit 3b83ce6

File tree

1 file changed

+211
-0
lines changed

1 file changed

+211
-0
lines changed

swagger.yml

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,6 +1152,7 @@ paths:
11521152
in: body
11531153
schema:
11541154
$ref: '#/definitions/siteSetup'
1155+
required: false
11551156
- name: configure_dns
11561157
type: boolean
11571158
in: query
@@ -1629,6 +1630,143 @@ paths:
16291630
default:
16301631
$ref: '#/responses/error'
16311632
# end site/split_testing/{split_test_id/unpublish}
1633+
# begin /dns_zones/
1634+
/dns_zones:
1635+
post:
1636+
operationId: createDnsZone
1637+
consumes:
1638+
- application/json
1639+
parameters:
1640+
- name: DnsZoneParams
1641+
in: body
1642+
required: true
1643+
schema:
1644+
$ref: '#/definitions/dnsZoneSetup'
1645+
responses:
1646+
'201':
1647+
description: Created
1648+
schema:
1649+
$ref: '#/definitions/dnsZone'
1650+
default:
1651+
$ref: '#/responses/error'
1652+
get:
1653+
operationId: getDnsZones
1654+
responses:
1655+
'200':
1656+
description: 'get all DNS zones your user account has access to'
1657+
schema:
1658+
$ref: '#/definitions/dnsZones'
1659+
default:
1660+
$ref: '#/responses/error'
1661+
# end /dns_zones
1662+
# begin dns_zones/{zone_id or name}
1663+
/dns_zones/{zone_id}:
1664+
parameters:
1665+
- name: zone_id
1666+
type: string
1667+
in: path
1668+
required: true
1669+
get:
1670+
operationId: getDnsZone
1671+
responses:
1672+
'200':
1673+
description: 'get a single DNS zone'
1674+
schema:
1675+
$ref: '#/definitions/dnsZone'
1676+
default:
1677+
$ref: '#/responses/error'
1678+
delete:
1679+
operationId: deleteDnsZone
1680+
responses:
1681+
'204':
1682+
description: 'delete a single DNS zone'
1683+
default:
1684+
$ref: '#/responses/error'
1685+
# end dns_zones/{zone_id or zone name}
1686+
# begin dns_zones/{zone_id or name}/transfer
1687+
/dns_zones/{zone_id}/transfer:
1688+
parameters:
1689+
- name: zone_id
1690+
type: string
1691+
in: path
1692+
required: true
1693+
- name: account_id
1694+
type: string
1695+
in: query
1696+
description: 'the account you want to transfer the dns zone to'
1697+
required: true
1698+
put:
1699+
operationId: transferDnsZone
1700+
responses:
1701+
'200':
1702+
description: 'transfer a DNS zone to another account'
1703+
schema:
1704+
$ref: '#/definitions/dnsZone'
1705+
default:
1706+
$ref: '#/responses/error'
1707+
# end dns_zones/{zone_id or zone name}/transfer
1708+
# begin dns_zones/{zone_id or name}/dns_records
1709+
/dns_zones/{zone_id}/dns_records:
1710+
parameters:
1711+
- name: zone_id
1712+
type: string
1713+
in: path
1714+
required: true
1715+
get:
1716+
operationId: getDnsRecords
1717+
responses:
1718+
'200':
1719+
description: 'get all DNS records for a single DNS zone'
1720+
schema:
1721+
$ref: '#/definitions/dnsRecords'
1722+
default:
1723+
$ref: '#/responses/error'
1724+
post:
1725+
operationId: createDnsRecord
1726+
consumes:
1727+
- application/json
1728+
parameters:
1729+
- name: dns_record
1730+
in: body
1731+
required: true
1732+
schema:
1733+
$ref: '#/definitions/dnsRecordCreate'
1734+
responses:
1735+
'201':
1736+
description: Created
1737+
schema:
1738+
$ref: '#/definitions/dnsRecord'
1739+
default:
1740+
$ref: '#/responses/error'
1741+
# end dns_zones/{zone_id or zone name}/dns_records
1742+
# begin dns_zones/{zone_id or name}/dns_records/{dns_record_id}
1743+
/dns_zones/{zone_id}/dns_records/{dns_record_id}:
1744+
parameters:
1745+
- name: zone_id
1746+
type: string
1747+
in: path
1748+
required: true
1749+
- name: dns_record_id
1750+
type: string
1751+
in: path
1752+
required: true
1753+
get:
1754+
operationId: getIndividualDnsRecord
1755+
responses:
1756+
'200':
1757+
description: 'get a single DNS record'
1758+
schema:
1759+
$ref: '#/definitions/dnsRecord'
1760+
default:
1761+
$ref: '#/responses/error'
1762+
delete:
1763+
operationId: deleteDnsRecord
1764+
responses:
1765+
'204':
1766+
description: 'record deleted'
1767+
default:
1768+
$ref: '#/responses/error'
1769+
# end dns_zones/{zone_id or zone name}/dns_records/{dns_record_id}
16321770
definitions:
16331771
splitTestSetup:
16341772
type: object
@@ -2100,17 +2238,80 @@ definitions:
21002238
type: boolean
21012239
metadata:
21022240
type: object
2241+
dnsZoneSetup:
2242+
type: object
2243+
properties:
2244+
account_slug:
2245+
type: string
2246+
site_id:
2247+
type: string
2248+
name:
2249+
type: string
2250+
dnsZones:
2251+
type: array
2252+
items:
2253+
$ref: '#/definitions/dnsZone'
21032254
dnsZone:
21042255
type: object
21052256
properties:
21062257
id:
21072258
type: string
21082259
name:
21092260
type: string
2261+
errors:
2262+
type: array
2263+
items:
2264+
type: string
2265+
supported_record_types:
2266+
type: array
2267+
items:
2268+
type: string
2269+
user_id:
2270+
type: string
2271+
created_at:
2272+
type: string
2273+
format: dateTime
2274+
updated_at:
2275+
type: string
2276+
format: dateTime
21102277
records:
21112278
type: array
21122279
items:
21132280
$ref: '#/definitions/dnsRecord'
2281+
dns_servers:
2282+
type: array
2283+
items:
2284+
type: string
2285+
account_id:
2286+
type: string
2287+
site_id:
2288+
type: string
2289+
account_slug:
2290+
type: string
2291+
account_name:
2292+
type: string
2293+
domain:
2294+
type: string
2295+
ipv6_enabled:
2296+
type: boolean
2297+
dedicated:
2298+
type: string
2299+
dnsRecordCreate:
2300+
type: object
2301+
properties:
2302+
type:
2303+
type: string
2304+
hostname:
2305+
type: string
2306+
value:
2307+
type: string
2308+
ttl:
2309+
type: integer
2310+
format: int64
2311+
dnsRecords:
2312+
type: array
2313+
items:
2314+
$ref: '#/definitions/dnsRecord'
21142315
dnsRecord:
21152316
type: object
21162317
properties:
@@ -2128,6 +2329,16 @@ definitions:
21282329
priority:
21292330
type: integer
21302331
format: int64
2332+
dns_zone_id:
2333+
type: string
2334+
site_id:
2335+
type: string
2336+
flag:
2337+
type: string
2338+
tag:
2339+
type: string
2340+
managed:
2341+
type: boolean
21312342
sniCertificate:
21322343
type: object
21332344
properties:

0 commit comments

Comments
 (0)