mirror of
https://github.com/openziti/zrok.git
synced 2024-12-23 07:09:12 +01:00
121 lines
2.3 KiB
YAML
121 lines
2.3 KiB
YAML
info:
|
|
description: zrok client access
|
|
title: zrok
|
|
version: 1.0.0
|
|
|
|
paths:
|
|
/account:
|
|
post:
|
|
tags:
|
|
- identity
|
|
operationId: createAccount
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
schema:
|
|
$ref: "#/definitions/accountRequest"
|
|
responses:
|
|
201:
|
|
description: account created
|
|
schema:
|
|
$ref: "#/definitions/accountResponse"
|
|
400:
|
|
description: account not created (already exists)
|
|
500:
|
|
description: internal server error
|
|
/enable:
|
|
post:
|
|
tags:
|
|
- identity
|
|
operationId: enable
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
schema:
|
|
$ref: "#/definitions/enableRequest"
|
|
responses:
|
|
201:
|
|
description: environment enabled
|
|
schema:
|
|
$ref: "#/definitions/enableResponse"
|
|
404:
|
|
description: account not found
|
|
500:
|
|
description: internal server error
|
|
/tunnel:
|
|
post:
|
|
tags:
|
|
- tunnel
|
|
operationId: tunnel
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
schema:
|
|
$ref: "#/definitions/tunnelRequest"
|
|
responses:
|
|
201:
|
|
description: tunnel created
|
|
schema:
|
|
$ref: "#/definitions/tunnelResponse"
|
|
/version:
|
|
get:
|
|
tags:
|
|
- metadata
|
|
operationId: version
|
|
responses:
|
|
200:
|
|
description: retrieve the current server version
|
|
schema:
|
|
$ref: "#/definitions/version"
|
|
|
|
definitions:
|
|
version:
|
|
type: object
|
|
properties:
|
|
version:
|
|
type: string
|
|
accountRequest:
|
|
type: object
|
|
properties:
|
|
username:
|
|
type: string
|
|
password:
|
|
type: string
|
|
accountResponse:
|
|
type: object
|
|
properties:
|
|
token:
|
|
type: string
|
|
enableRequest:
|
|
type: object
|
|
properties:
|
|
token:
|
|
type: string
|
|
enableResponse:
|
|
type: object
|
|
properties:
|
|
identity:
|
|
type: string
|
|
cfg:
|
|
type: string
|
|
tunnelRequest:
|
|
type: object
|
|
properties:
|
|
identity:
|
|
type: string
|
|
endpoint:
|
|
type: string
|
|
tunnelResponse:
|
|
type: object
|
|
properties:
|
|
service:
|
|
type: string
|
|
|
|
produces:
|
|
- application/zrok.v1+json
|
|
consumes:
|
|
- application/zrok.v1+json
|
|
schemes:
|
|
- http
|
|
swagger: "2.0"
|