FilesExpand file tree

main

/

api.yaml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

273 lines (254 loc) · 6.6 KB

main

/

api.yaml

Copy path

Top

File metadata and controls

• Code
• Blame

273 lines (254 loc) · 6.6 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

openapi: 3.0.3

info:

title: DockRouter Admin API

description: Admin API for DockRouter - Docker-native ingress router

version: 1.2.1

contact:

name: DockRouter

url: https://github.com/DockRouter/dockrouter

license:

name: MIT

url: https://opensource.org/licenses/MIT

servers:

- url: http://localhost:9090

description: Local development server

paths:

/api/v1/status:

get:

summary: Get system status

description: Returns current system status including uptime, route count, and container count

operationId: getStatus

tags:

- System

responses:

'200':

description: System status

content:

application/json:

schema:

$ref: '#/components/schemas/Status'

example:

status: ok

version: 1.0.0

routes: 5

containers: 3

certificates: 2

uptime: 1h30m15s

http_port: 80

https_port: 443

/api/v1/routes:

get:

summary: List all routes

description: Returns all configured routes with their backends and health status

operationId: listRoutes

tags:

- Routes

responses:

'200':

description: List of routes

content:

application/json:

schema:

type: array

items:

$ref: '#/components/schemas/Route'

/api/v1/containers:

get:

summary: List all containers

description: Returns all discovered Docker containers with their labels

operationId: listContainers

tags:

- Containers

responses:

'200':

description: List of containers

content:

application/json:

schema:

type: array

items:

$ref: '#/components/schemas/Container'

/api/v1/certificates:

get:

summary: List all certificates

description: Returns all managed TLS certificates

operationId: listCertificates

tags:

- Certificates

responses:

'200':

description: List of certificates

content:

application/json:

schema:

type: array

items:

$ref: '#/components/schemas/Certificate'

/api/v1/health:

get:

summary: Health check

description: Simple health check endpoint

operationId: healthCheck

tags:

- System

responses:

'200':

description: System is healthy

content:

application/json:

schema:

type: object

properties:

status:

type: string

example: healthy

/api/v1/metrics:

get:

summary: Prometheus metrics

description: Returns metrics in Prometheus text format

operationId: getMetrics

tags:

- Observability

responses:

'200':

description: Prometheus metrics

content:

text/plain:

schema:

type: string

example: |

# HELP http_requests_total Total HTTP requests

# TYPE http_requests_total counter

http_requests_total{method="GET",status="200"} 1234

/api/v1/config:

get:

summary: Get configuration

description: Returns current configuration (sensitive values masked)

operationId: getConfig

tags:

- System

responses:

'200':

description: Current configuration

content:

application/json:

schema:

$ref: '#/components/schemas/Config'

/api/v1/events:

get:

summary: Stream live events

description: |

Server-Sent Events stream of route, container and certificate changes.

The dashboard consumes it to refresh itself without polling.

The connection stays open; each change is delivered as a `data:` line

holding a JSON object with a `type` and a `data` field. A `: keepalive`

comment is emitted periodically so intermediaries do not close an idle

stream.

operationId: streamEvents

tags:

- System

responses:

'200':

description: Event stream

content:

text/event-stream:

schema:

type: string

example: |

data: {"type":"route.added","data":{"host":"app.example.com","backend":"172.17.0.5:80"}}

data: {"type":"container.stopped","data":{"id":"abc123def456"}}

'503':

description: The event hub is not available

components:

schemas:

Status:

type: object

properties:

status:

type: string

enum: [ok, degraded, error]

version:

type: string

routes:

type: integer

containers:

type: integer

certificates:

type: integer

uptime:

type: string

http_port:

type: integer

https_port:

type: integer

Route:

type: object

properties:

id:

type: string

host:

type: string

path_prefix:

type: string

backend:

type: string

tls:

type: boolean

healthy:

type: boolean

Container:

type: object

properties:

id:

type: string

name:

type: string

image:

type: string

host:

type: string

address:

type: string

running:

type: boolean

status:

type: string

healthy:

type: boolean

labels:

type: integer

Certificate:

type: object

properties:

domain:

type: string

Config:

type: object

properties:

http_port:

type: integer

https_port:

type: integer

admin:

type: boolean

acme_email:

type: string

log_level:

type: string

securitySchemes:

basicAuth:

type: http

scheme: basic

security:

- basicAuth: []

tags:

- name: System

description: System status and configuration

- name: Routes

description: Route management

- name: Containers

description: Container discovery

- name: Certificates

description: TLS certificate management

- name: Observability

description: Metrics and monitoring