Overview

Version information

Version : 1.0.0

URI scheme

Host : cloudentity.dev.cloudentity.com
BasePath : /api
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

GET /apigw-configurator/config/application/{applicationId}/endpoints

Description

Get configured endponts for application

Parameters

Type Name Schema

Path

applicationId
required

string

Responses

HTTP Code Description Schema

200

List of endpoints.

Endpoints

500

Response details:

  • Code : Message

Error

Tags

  • apiGatewayConfigurator

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

PUT /apigw-configurator/config/application/{applicationId}/endpoints

Description

Get configured endponts for application

Parameters

Type Name Description Schema

Path

applicationId
required

string

Body

endpoints
required

Endpoints configuration

Endpoints

Responses

HTTP Code Description Schema

200

Endpoints saved

No Content

400

  • BadBody: Provided body param with endpoints is not valid

Error

500

Response details:

  • Code : Message

Error

Tags

  • apiGatewayConfigurator

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

GET /config/application/{applicationId}/endpoints

Description

Get configured endponts for application

Parameters

Type Name Schema

Path

applicationId
required

string

Responses

HTTP Code Description Schema

200

List of endpoints.

Endpoints

500

Response details:

  • Code : Message

Error

Tags

  • apiGatewayConfigurator

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

PUT /config/application/{applicationId}/endpoints

Description

Get configured endponts for application

Parameters

Type Name Description Schema

Path

applicationId
required

string

Body

endpoints
required

Endpoints configuration

Endpoints

Responses

HTTP Code Description Schema

200

Endpoints saved

No Content

400

  • BadBody: Provided body param with endpoints is not valid

Error

500

Response details:

  • Code : Message

Error

Tags

  • apiGatewayConfigurator

Security

Type Name

oauth2

oauth2_implicit

oauth2

oauth2_authorizationCode

oauth2

oauth2_password

apiKey

SsoToken

Definitions

AliveStatus

Name Description Schema

message
optional

Description of API Gateway status if available

string

EndpointConf

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

request
optional

request

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

response
optional

response

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

request

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

EndpointFlowConf

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

EndpointFlowsConf

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

Endpoints

Name Schema

endpoints
optional

< endpoints > array

endpoints

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

request
optional

request

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

response
optional

response

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

request

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

Error

Name Description Schema

code
optional

Unique internal error code

string

details
optional

Optional. Varies depending on the specific use case - details are determined by the particular API call.

object

message
optional

Description of the error code

string

PluginConf

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

RuleRawConf

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

Rules

Name Schema

rules
optional

< rules > array

rules

Name Schema

default
optional

default

endpoints
optional

< endpoints > array

request
optional

request

response
optional

response

default

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

endpoints

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

request
optional

request

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

response
optional

response

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

request

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

request

Name Schema

postFlow
optional

< postFlow > array

preFlow
optional

< preFlow > array

postFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

preFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

< postFlow > array

preFlow
optional

< preFlow > array

postFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

preFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

RulesBlock

Name Schema

default
optional

default

endpoints
optional

< endpoints > array

request
optional

request

response
optional

response

default

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

endpoints

Name Description Schema

dropPrefix
optional

boolean

endpointName
optional

Name of endpoint

string

method
optional

Example : "GET/POST/PUT/DELETE"

string

pathPattern
optional

Pattern of an endpoint path

string

pathPrefix
optional

string

request
optional

request

requestPlugins
optional

Plugins of endpoint request

< requestPlugins > array

response
optional

response

responsePlugins
optional

Plugins of endpoint response

< responsePlugins > array

rewritePath
optional

Path to which the initial one will be rewritten

string

targetHost
optional

Target host

string

targetPort
optional

integer

targetProxy
optional

boolean

targetService
optional

string

request

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

requestPlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

postFlow

preFlow
optional

preFlow

postFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

preFlow

Name Schema

disableAllPlugins
optional

boolean

disablePlugins
optional

< string > array

responsePlugins

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

request

Name Schema

postFlow
optional

< postFlow > array

preFlow
optional

< preFlow > array

postFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

preFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

response

Name Schema

postFlow
optional

< postFlow > array

preFlow
optional

< preFlow > array

postFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

preFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

ServiceFlowsConf

Name Schema

postFlow
optional

< postFlow > array

preFlow
optional

< preFlow > array

postFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

preFlow

Name Description Schema

conf
optional

Plugin configuration in json object format

object

pluginName
optional

Name of plugin

string

Security

oauth2_implicit

Type : oauth2
Flow : implicit
Token URL : https://cloudentity.dev.cloudentity.com/oauth/authorize

oauth2_authorizationCode

Type : oauth2
Flow : accessCode
Token URL : https://cloudentity.dev.cloudentity.com/oauth/authorize
Token URL : https://cloudentity.dev.cloudentity.com/oauth/token

oauth2_password

Type : oauth2
Flow : password
Token URL : https://cloudentity.dev.cloudentity.com/oauth/token

SsoToken

Type : apiKey
Name : token
In : HEADER