Skip to content

Latest commit

 

History

History
4014 lines (2363 loc) · 59.1 KB

api-reference.md

File metadata and controls

4014 lines (2363 loc) · 59.1 KB
Raw

Dragonfly Manager

Overview

Dragonfly Manager Server

Version information

Version : 1.0.0

License information

License : Apache 2.0
Terms of service : null

URI scheme

Host : localhost:8080
BasePath : /api/v1

Paths

Create Application

POST /api/v1/applications

Description

create by json config

Parameters

Type Name Description Schema
Body Application
required		 Application types.CreateApplicationRequest

Responses

HTTP Code Description Schema
200 OK model.Application
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Get Applications

GET /api/v1/applications

Description

Get Applications

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.Application > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Get Application

GET /api/v1/applications/{id}

Description

Get Application by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.Application
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Destroy Application

DELETE /api/v1/applications/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Update Application

PATCH /api/v1/applications/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body Application
required		 Application types.UpdateApplicationRequest

Responses

HTTP Code Description Schema
200 OK model.Application
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Add CDN to Application

PUT /api/v1/applications/{id}/cdn-clusters/{cdn_cluster_id}

Description

Add CDN to Application

Parameters

Type Name Description Schema
Path cdn_cluster_id
required		 cdn cluster id string
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Delete CDN to Application

DELETE /api/v1/applications/{id}/cdn-clusters/{cdn_cluster_id}

Description

Delete CDN to Application

Parameters

Type Name Description Schema
Path cdn_cluster_id
required		 cdn cluster id string
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Add Scheduler to Application

PUT /api/v1/applications/{id}/scheduler-clusters/{scheduler_cluster_id}

Description

Add Scheduler to Application

Parameters

Type Name Description Schema
Path id
required		 id string
Path scheduler_cluster_id
required		 scheduler cluster id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Delete Scheduler to Application

DELETE /api/v1/applications/{id}/scheduler-clusters/{scheduler_cluster_id}

Description

Delete Scheduler to Application

Parameters

Type Name Description Schema
Path id
required		 id string
Path scheduler_cluster_id
required		 scheduler cluster id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Application

Create CDNCluster

POST /api/v1/cdn-clusters

Description

create by json config

Parameters

Type Name Description Schema
Body CDNCluster
required		 DNCluster types.CreateCDNClusterRequest

Responses

HTTP Code Description Schema
200 OK model.CDNCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Get CDNClusters

GET /api/v1/cdn-clusters

Description

Get CDNClusters

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.CDNCluster > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Get CDNCluster

GET /api/v1/cdn-clusters/{id}

Description

Get CDNCluster by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.CDNCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Destroy CDNCluster

DELETE /api/v1/cdn-clusters/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Update CDNCluster

PATCH /api/v1/cdn-clusters/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body CDNCluster
required		 CDNCluster types.UpdateCDNClusterRequest

Responses

HTTP Code Description Schema
200 OK model.CDNCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Add Instance to CDNCluster

PUT /api/v1/cdn-clusters/{id}/cdns/{cdn_id}

Description

Add CDN to CDNCluster

Parameters

Type Name Description Schema
Path cdn_id
required		 cdn id string
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Add SchedulerCluster to CDNCluster

PUT /api/v1/cdn-clusters/{id}/scheduler-clusters/{scheduler_cluster_id}

Description

Add SchedulerCluster to CDNCluster

Parameters

Type Name Description Schema
Path id
required		 id string
Path scheduler_cluster_id
required		 scheduler cluster id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDNCluster

Create CDN

POST /api/v1/cdns

Description

create by json config

Parameters

Type Name Description Schema
Body CDN
required		 CDN types.CreateCDNRequest

Responses

HTTP Code Description Schema
200 OK model.CDN
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Get CDNs

GET /api/v1/cdns

Description

Get CDNs

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.CDN > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Get CDN

GET /api/v1/cdns/{id}

Description

Get CDN by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.CDN
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Destroy CDN

DELETE /api/v1/cdns/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Update CDN

PATCH /api/v1/cdns/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body CDN
required		 CDN types.UpdateCDNRequest

Responses

HTTP Code Description Schema
200 OK model.CDN
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Create Config

POST /api/v1/configs

Description

create by json config

Parameters

Type Name Description Schema
Body Config
required		 Config types.CreateConfigRequest

Responses

HTTP Code Description Schema
200 OK model.Config
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Config

Get Configs

GET /api/v1/configs

Description

Get Configs

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.Config > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Config

Get Config

GET /api/v1/configs/{id}

Description

Get Config by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.Config
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Config

Destroy Config

DELETE /api/v1/configs/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Config

Update Config

PATCH /api/v1/configs/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body Config
required		 Config types.UpdateConfigRequest

Responses

HTTP Code Description Schema
200 OK model.Config
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Config

Get Health

GET /api/v1/healthy

Description

Get app health

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Health

Create Job

POST /api/v1/jobs

Description

create by json config

Parameters

Type Name Description Schema
Body Job
required		 Job types.CreateJobRequest

Responses

HTTP Code Description Schema
200 OK model.Job
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Job

Get Jobs

GET /api/v1/jobs

Description

Get Jobs

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.Job > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Job

Get Job

GET /api/v1/jobs/{id}

Description

Get Job by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.Job
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Job

Destroy Job

DELETE /api/v1/jobs/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Job

Update Job

PATCH /api/v1/jobs/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body Job
required		 Job types.UpdateJobRequest

Responses

HTTP Code Description Schema
200 OK model.Job
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Job

Create Oauth

POST /api/v1/oauth

Description

create by json config

Parameters

Type Name Description Schema
Body Oauth
required		 Oauth types.CreateOauthRequest

Responses

HTTP Code Description Schema
200 OK model.Oauth
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Oauth

Get Oauths

GET /api/v1/oauth

Description

Get Oauths

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.Oauth > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Oauth

Get Oauth

GET /api/v1/oauth/{id}

Description

Get Oauth by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.Oauth
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Oauth

Destroy Oauth

DELETE /api/v1/oauth/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Oauth

Update Oauth

PATCH /api/v1/oauth/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body Oauth
required		 Oauth types.UpdateOauthRequest

Responses

HTTP Code Description Schema
200 OK model.Oauth
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Oauth

Get Permissions

GET /api/v1/permissions

Description

Get Permissions

Responses

HTTP Code Description Schema
200 OK < rbac.Permission > array
400 No Content
500 No Content

Produces

  • application/json

Tags

  • Permission

Create V1 Preheat

POST /api/v1/preheats

Description

create by json config

Parameters

Type Name Description Schema
Body CDN
required		 Preheat types.CreateV1PreheatRequest

Responses

HTTP Code Description Schema
200 OK types.CreateV1PreheatResponse
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Preheat

Get V1 Preheat

GET /api/v1/preheats/{id}

Description

Get Preheat by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK types.GetV1PreheatResponse
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Preheat

Create Role

POST /api/v1/roles

Description

Create Role by json config

Parameters

Type Name Description Schema
Body Role
required		 Role types.CreateRoleRequest

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Get Roles

GET /api/v1/roles

Description

Get roles

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Get Role

GET /api/v1/roles/:role

Description

Get Role

Parameters

Type Name Description Schema
Path role
required		 role string

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Destroy Role

DELETE /api/v1/roles/:role

Description

Destroy role by json config

Parameters

Type Name Description Schema
Path role
required		 role string

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Add Permission For Role

POST /api/v1/roles/:role/permissions

Description

Add Permission by json config

Parameters

Type Name Description Schema
Path role
required		 role string
Body Permission
required		 Permission types.AddPermissionForRoleRequest

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Update Role

DELETE /api/v1/roles/:role/permissions

Description

Remove Role Permission by json config

Parameters

Type Name Description Schema
Path role
required		 role string
Body Permission
required		 Permission types.DeletePermissionForRoleRequest

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Role

Create SchedulerCluster

POST /api/v1/scheduler-clusters

Description

create by json config

Parameters

Type Name Description Schema
Body SchedulerCluster
required		 SchedulerCluster types.CreateSchedulerClusterRequest

Responses

HTTP Code Description Schema
200 OK model.SchedulerCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Get SchedulerClusters

GET /api/v1/scheduler-clusters

Description

Get SchedulerClusters

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.SchedulerCluster > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Get SchedulerCluster

GET /api/v1/scheduler-clusters/{id}

Description

Get SchedulerCluster by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.SchedulerCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Destroy SchedulerCluster

DELETE /api/v1/scheduler-clusters/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Update SchedulerCluster

PATCH /api/v1/scheduler-clusters/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body SchedulerCluster
required		 SchedulerCluster types.UpdateSchedulerClusterRequest

Responses

HTTP Code Description Schema
200 OK model.SchedulerCluster
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Add Scheduler to schedulerCluster

PUT /api/v1/scheduler-clusters/{id}/schedulers/{scheduler_id}

Description

Add Scheduler to schedulerCluster

Parameters

Type Name Description Schema
Path id
required		 id string
Path scheduler_id
required		 scheduler id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SchedulerCluster

Create Scheduler

POST /api/v1/schedulers

Description

create by json config

Parameters

Type Name Description Schema
Body Scheduler
required		 Scheduler types.CreateSchedulerRequest

Responses

HTTP Code Description Schema
200 OK model.Scheduler
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scheduler

Get Schedulers

GET /api/v1/schedulers

Description

Get Schedulers

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.Scheduler > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scheduler

Get Scheduler

GET /api/v1/schedulers/{id}

Description

Get Scheduler by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.Scheduler
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scheduler

Destroy Scheduler

DELETE /api/v1/schedulers/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scheduler

Update Scheduler

PATCH /api/v1/schedulers/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body Scheduler
required		 Scheduler types.UpdateSchedulerRequest

Responses

HTTP Code Description Schema
200 OK model.Scheduler
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scheduler

Create SecurityGroup

POST /api/v1/security-groups

Description

create by json config

Parameters

Type Name Description Schema
Body SecurityGroup
required		 SecurityGroup types.CreateSecurityGroupRequest

Responses

HTTP Code Description Schema
200 OK model.SecurityGroup
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Get SecurityGroups

GET /api/v1/security-groups

Description

Get SecurityGroups

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.SecurityGroup > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Get SecurityGroup

GET /api/v1/security-groups/{id}

Description

Get SecurityGroup by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.SecurityGroup
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Update SecurityGroup

PATCH /api/v1/security-groups/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body SecurityGroup
required		 SecurityGroup types.UpdateSecurityGroupRequest

Responses

HTTP Code Description Schema
200 OK model.SecurityGroup
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Add CDN to SecurityGroup

PUT /api/v1/security-groups/{id}/cdn-clusters/{cdn_cluster_id}

Description

Add CDN to SecurityGroup

Parameters

Type Name Description Schema
Path cdn_cluster_id
required		 cdn cluster id string
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Add Scheduler to SecurityGroup

PUT /api/v1/security-groups/{id}/scheduler-clusters/{scheduler_cluster_id}

Description

Add Scheduler to SecurityGroup

Parameters

Type Name Description Schema
Path id
required		 id string
Path scheduler_cluster_id
required		 scheduler cluster id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Add SecurityRule to SecurityGroup

PUT /api/v1/security-groups/{id}/security-rules/{security_rule_id}

Description

Add SecurityRule to SecurityGroup

Parameters

Type Name Description Schema
Path id
required		 id string
Path security_rule_id
required		 security rule id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Destroy SecurityRule to SecurityGroup

DELETE /api/v1/security-groups/{id}/security-rules/{security_rule_id}

Description

Destroy SecurityRule to SecurityGroup

Parameters

Type Name Description Schema
Path id
required		 id string
Path security_rule_id
required		 security rule id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Create SecurityRule

POST /api/v1/security-rules

Description

create by json config

Parameters

Type Name Description Schema
Body SecurityRule
required		 SecurityRule types.CreateSecurityRuleRequest

Responses

HTTP Code Description Schema
200 OK model.SecurityRule
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityRule

Get SecurityRules

GET /api/v1/security-rules

Description

Get SecurityRules

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.SecurityRule > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityRule

Get SecurityRule

GET /api/v1/security-rules/{id}

Description

Get SecurityRule by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.SecurityRule
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityRule

Update SecurityRule

PATCH /api/v1/security-rules/{id}

Description

Update by json config

Parameters

Type Name Description Schema
Path id
required		 id string
Body SecurityRule
required		 SecurityRule types.UpdateSecurityRuleRequest

Responses

HTTP Code Description Schema
200 OK model.SecurityRule
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityRule

Destroy SecurityGroup

DELETE /api/v1/securityGroups/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityGroup

Destroy SecurityRule

DELETE /api/v1/securityRules/{id}

Description

Destroy by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • SecurityRule

Oauth Signin

GET /api/v1/user/signin/{name}

Description

oauth signin by json config

Parameters

Type Name Description Schema
Path name
required		 name string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • User

Oauth Signin Callback

GET /api/v1/user/signin/{name}/callback

Description

oauth signin callback by json config

Parameters

Type Name Description Schema
Path name
required		 name string
Query code
required		 code string

Responses

HTTP Code Schema
200 No Content
400 No Content
404 No Content
500 No Content

Tags

  • Oauth

SignUp user

POST /api/v1/user/signup

Description

signup by json config

Parameters

Type Name Description Schema
Body User
required		 User types.SignUpRequest

Responses

HTTP Code Description Schema
200 OK model.User
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • User

Get Users

GET /api/v1/users

Description

Get Users

Parameters

Type Name Description Schema Default
Query page
required		 current page integer 0
Query per_page
required		 return max item count, default 10, max 50 integer 10

Responses

HTTP Code Description Schema
200 OK < model.CDN > array
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • CDN

Get User

GET /api/v1/users/{id}

Description

Get User by id

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK model.User
400 No Content
404 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • User

Reset Password For User

POST /api/v1/users/{id}/reset_password

Description

reset password by json config

Parameters

Type Name Description Schema
Body User
required		 User types.ResetPasswordRequest

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • User

Get User Roles

GET /api/v1/users/{id}/roles

Description

get roles by json config

Parameters

Type Name Description Schema
Path id
required		 id string

Responses

HTTP Code Description Schema
200 OK < string > array
400 No Content
500 No Content

Produces

  • application/json

Tags

  • User

Add Role For User

PUT /api/v1/users/{id}/roles/{role}

Description

add role to user by uri config

Parameters

Type Name Description Schema
Path id
required		 id string
Path role
required		 role string

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Users

Delete Role For User

DELETE /api/v1/users/{id}/roles/{role}

Description

delete role by uri config

Parameters

Type Name Description Schema
Path id
required		 id string
Path role
required		 role string

Responses

HTTP Code Schema
200 No Content
400 No Content
500 No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Users

Definitions

model.Application

Name Schema
bio
optional		 string
cdn_clusters
optional		 < model.CDNCluster > array
created_at
optional		 string
download_rate_limit
optional		 integer
id
optional		 integer
name
optional		 string
scheduler_clusters
optional		 < model.SchedulerCluster > array
state
optional		 string
updated_at
optional		 string
url
optional		 string
user
optional		 model.User
user_id
optional		 integer

model.CDN

Name Schema
cdnclusterID
optional		 integer
created_at
optional		 string
download_port
optional		 integer
host_name
optional		 string
id
optional		 integer
idc
optional		 string
ip
optional		 string
location
optional		 string
port
optional		 integer
state
optional		 string
updated_at
optional		 string

model.CDNCluster

Name Schema
application_id
optional		 integer
bio
optional		 string
config
optional		 model.JSONMap
created_at
optional		 string
id
optional		 integer
is_default
optional		 boolean
jobs
optional		 < model.Job > array
name
optional		 string
scheduler_clusters
optional		 < model.SchedulerCluster > array
security_group_id
optional		 integer
updated_at
optional		 string

model.Config

Name Schema
bio
optional		 string
created_at
optional		 string
id
optional		 integer
name
optional		 string
updated_at
optional		 string
user_id
optional		 integer
value
optional		 string

model.JSONMap

Type : object

model.Job

Name Schema
args
optional		 model.JSONMap
bio
optional		 string
cdn_clusters
optional		 < model.CDNCluster > array
created_at
optional		 string
id
optional		 integer
result
optional		 model.JSONMap
scheduler_clusters
optional		 < model.SchedulerCluster > array
state
optional		 string
task_id
optional		 string
type
optional		 string
updated_at
optional		 string
user_id
optional		 integer

model.Oauth

Name Schema
bio
optional		 string
client_id
optional		 string
client_secret
optional		 string
created_at
optional		 string
id
optional		 integer
name
optional		 string
redirect_url
optional		 string
updated_at
optional		 string

model.Scheduler

Name Schema
created_at
optional		 string
host_name
optional		 string
id
optional		 integer
idc
optional		 string
ip
optional		 string
location
optional		 string
net_config
optional		 model.JSONMap
port
optional		 integer
schedulerClusterID
optional		 integer
state
optional		 string
updated_at
optional		 string
vips
optional		 string

model.SchedulerCluster

Name Schema
application_id
optional		 integer
bio
optional		 string
cdn_clusters
optional		 < model.CDNCluster > array
client_config
optional		 model.JSONMap
config
optional		 model.JSONMap
created_at
optional		 string
id
optional		 integer
is_default
optional		 boolean
jobs
optional		 < model.Job > array
name
optional		 string
scopes
optional		 model.JSONMap
security_group_id
optional		 integer
updated_at
optional		 string

model.SecurityGroup

Name Schema
bio
optional		 string
created_at
optional		 string
id
optional		 integer
name
optional		 string
security_rules
optional		 < model.SecurityRule > array
updated_at
optional		 string

model.SecurityRule

Name Schema
bio
optional		 string
created_at
optional		 string
domain
optional		 string
id
optional		 integer
name
optional		 string
proxy_domain
optional		 string
security_groups
optional		 < model.SecurityGroup > array
updated_at
optional		 string

model.User

Name Schema
avatar
optional		 string
bio
optional		 string
created_at
optional		 string
email
optional		 string
id
optional		 integer
location
optional		 string
name
optional		 string
phone
optional		 string
state
optional		 string
updated_at
optional		 string

rbac.Permission

Name Schema
action
required		 string
object
required		 string

types.AddPermissionForRoleRequest

Name Schema
action
required		 string
object
required		 string

types.CDNClusterConfig

Name Schema
load_limit
optional		 integer
net_topology
optional		 string

types.CreateApplicationRequest

Name Schema
bio
optional		 string
download_rate_limit
optional		 integer
name
required		 string
state
optional		 string
url
optional		 string
user_id
required		 integer

types.CreateCDNClusterRequest

Name Schema
bio
optional		 string
config
required		 types.CDNClusterConfig
is_default
optional		 boolean
name
required		 string

types.CreateCDNRequest

Name Schema
cdn_cluster_id
required		 integer
download_port
required		 integer
host_name
required		 string
idc
required		 string
ip
required		 string
location
optional		 string
port
required		 integer

types.CreateConfigRequest

Name Schema
bio
optional		 string
name
required		 string
user_id
required		 integer
value
required		 string

types.CreateJobRequest

Name Schema
args
optional		 object
bio
optional		 string
cdn_cluster_ids
optional		 < integer > array
result
optional		 object
scheduler_cluster_ids
optional		 < integer > array
type
required		 string
user_id
optional		 integer

types.CreateOauthRequest

Name Schema
bio
optional		 string
client_id
required		 string
client_secret
required		 string
name
required		 string
redirect_url
optional		 string

types.CreateRoleRequest

Name Schema
permissions
required		 < rbac.Permission > array
role
required		 string

types.CreateSchedulerClusterRequest

Name Schema
bio
optional		 string
cdn_cluster_id
optional		 integer
client_config
required		 types.SchedulerClusterClientConfig
config
required		 types.SchedulerClusterConfig
is_default
optional		 boolean
name
required		 string
scopes
optional		 types.SchedulerClusterScopes

types.CreateSchedulerRequest

Name Schema
host_name
required		 string
idc
required		 string
ip
required		 string
location
optional		 string
net_config
optional		 object
port
required		 integer
scheduler_cluster_id
required		 integer
vips
optional		 string

types.CreateSecurityGroupRequest

Name Schema
bio
optional		 string
name
required		 string

types.CreateSecurityRuleRequest

Name Schema
bio
optional		 string
domain
required		 string
name
required		 string
proxy_domain
optional		 string

types.CreateV1PreheatRequest

Name Schema
filter
optional		 string
headers
optional		 < string, string > map
type
required		 string
url
required		 string

types.CreateV1PreheatResponse

Name Schema
id
optional		 string

types.DeletePermissionForRoleRequest

Name Schema
action
required		 string
object
required		 string

types.GetV1PreheatResponse

Name Schema
finishTime
optional		 string
id
optional		 string
startTime
optional		 string
status
optional		 string

types.ResetPasswordRequest

Name Schema
new_password
required		 string
old_password
required		 string

types.SchedulerClusterClientConfig

Name Schema
load_limit
optional		 integer

types.SchedulerClusterConfig

Type : object

types.SchedulerClusterScopes

Name Schema
idc
optional		 string
location
optional		 string
net_topology
optional		 string

types.SignUpRequest

Name Schema
avatar
optional		 string
bio
optional		 string
email
required		 string
location
optional		 string
name
required		 string
password
required		 string
phone
optional		 string

types.UpdateApplicationRequest

Name Schema
bio
optional		 string
download_rate_limit
optional		 integer
name
optional		 string
state
optional		 string
url
optional		 string
user_id
required		 integer

types.UpdateCDNClusterRequest

Name Schema
bio
optional		 string
config
optional		 types.CDNClusterConfig
is_default
optional		 boolean
name
optional		 string

types.UpdateCDNRequest

Name Schema
cdn_cluster_id
optional		 integer
download_port
optional		 integer
idc
optional		 string
ip
optional		 string
location
optional		 string
port
optional		 integer

types.UpdateConfigRequest

Name Schema
bio
optional		 string
name
optional		 string
user_id
optional		 integer
value
optional		 string

types.UpdateJobRequest

Name Schema
bio
optional		 string
user_id
optional		 integer

types.UpdateOauthRequest

Name Schema
bio
optional		 string
client_id
optional		 string
client_secret
optional		 string
name
optional		 string
redirect_url
optional		 string

types.UpdateSchedulerClusterRequest

Name Schema
bio
optional		 string
cdn_cluster_id
optional		 integer
client_config
optional		 types.SchedulerClusterClientConfig
config
optional		 types.SchedulerClusterConfig
is_default
optional		 boolean
name
optional		 string
scopes
optional		 types.SchedulerClusterScopes

types.UpdateSchedulerRequest

Name Schema
idc
optional		 string
ip
optional		 string
location
optional		 string
net_config
optional		 object
port
optional		 integer
scheduler_cluster_id
optional		 integer
scheduler_id
optional		 integer
vips
optional		 string

types.UpdateSecurityGroupRequest

Name Schema
bio
optional		 string
name
optional		 string

types.UpdateSecurityRuleRequest

Name Schema
bio
optional		 string
domain
optional		 string
name
optional		 string
proxy_domain
optional		 string