-
Notifications
You must be signed in to change notification settings - Fork 3
/
swagger.yaml
executable file
·74 lines (74 loc) · 1.77 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
swagger: "2.0"
info:
description: "SynergyCP rDNS Package API documentation"
version: "1.0.0"
title: "SynergyCP rDNS Package"
host: "api.yoursynergycp.com"
basePath: "/pkg/rdns/"
schemes:
- "http"
- "https"
paths:
/ptr:
post:
summary: "Create a new PTR Record, or overwrite an existing one"
description: ""
operationId: "addPtr"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
description: "The PTR Record that needs to be added to the DNS server"
schema:
$ref: "#/definitions/Ptr"
responses:
400:
description: "Invalid input"
security:
- api_key: []
get:
summary: "List all PTR Records"
description: ""
produces:
- "application/json"
parameters:
- in: "query"
name: "entity"
description: "(Optional) The ID of the IP entity you wish to lookup records for"
type: "integer"
format: "int64"
- in: "query"
name: "q"
description: "(Optional) Text-based search of the PTR and IP records"
type: "string"
responses:
400:
description: "Invalid input"
security:
- api_key: []
securityDefinitions:
api_key:
type: "apiKey"
name: "key"
in: "query"
definitions:
Ptr:
type: "object"
required:
- "name"
- "photoUrls"
properties:
id:
type: "integer"
ptr:
type: "string"
example: "some.hostname"
description: "The hostname that the PTR record should point to"
ip:
type: "string"
example: "1.1.1.1"
description: "The IP address that needs to point to the PTR record"