Skip to main content

API7 Enterprise Admin APIs (3.2.11.1)

Download OpenAPI specification:Download

API7 Enterprise Admin APIs are RESTful APIs that allow you to create and manage API7 resources.

Services

Create a service.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
non-empty
name
required
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

hosts
Array of strings [ 1 .. 32 ] items unique

The hosts for the service to accept incoming requests.

path_prefix
string [ 1 .. 4096 ] characters ^/

The listening path prefix of the service.

strip_path_prefix
boolean
Default: true

Weather strip the path prefix or not when proxying the request to the upstream.

plugins
object

The key-value pairs which represent the plugins attached on the object.

object

The upstream contains necessary information for the gateway to proxy request to the backend service.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "hosts": [
    ],
  • "path_prefix": "string",
  • "strip_path_prefix": true,
  • "plugins": { },
  • "upstream": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all services.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at" "last_published"
search
string

The search keyword.

object non-empty
gateway_group_id
string >= 1
last_publish_start_at
integer >= 0
last_publish_end_at
integer >= 0
is_permitted
boolean
Default: false

Filter the resources that the current user has permissions to operate on.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

Request Body schema: application/json
non-empty
name
required
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

hosts
Array of strings [ 1 .. 32 ] items unique

The hosts for the service to accept incoming requests.

path_prefix
string [ 1 .. 4096 ] characters ^/

The listening path prefix of the service.

strip_path_prefix
boolean
Default: true

Weather strip the path prefix or not when proxying the request to the upstream.

plugins
object

The key-value pairs which represent the plugins attached on the object.

object

The upstream contains necessary information for the gateway to proxy request to the backend service.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "hosts": [
    ],
  • "path_prefix": "string",
  • "strip_path_prefix": true,
  • "plugins": { },
  • "upstream": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

query Parameters
dry-run
string
Value: "all"

The flag that indicates whether to run the operation in dry-run mode.

Request Body schema: application/json
non-empty
name
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

hosts
Array of strings [ 1 .. 32 ] items unique

The hosts for the service to accept incoming requests.

path_prefix
string [ 1 .. 4096 ] characters ^/

The listening path prefix of the service.

strip_path_prefix
boolean
Default: true

Weather strip the path prefix or not when proxying the request to the upstream.

plugins
object

The key-value pairs which represent the plugins attached on the object.

object

The upstream contains necessary information for the gateway to proxy request to the backend service.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "hosts": [
    ],
  • "path_prefix": "string",
  • "strip_path_prefix": true,
  • "plugins": { },
  • "upstream": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Publish a service.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
non-empty
create_new_version
boolean

Whether to create a new service version for the updated service.

gateway_group_id
string^[a-zA-Z0-9-_.]+$

The object ID.

Array of objects non-empty [ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "create_new_version": true,
  • "gateway_group_id": "string",
  • "services": [
    ]
}

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Check service conflict.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
non-empty
create_new_version
boolean

Whether to create a new service version for the updated service.

gateway_group_id
string^[a-zA-Z0-9-_.]+$

The object ID.

Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "create_new_version": true,
  • "gateway_group_id": "string",
  • "services": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all permitted users.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

query Parameters
direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

page
integer <int64> >= 1

The page number, starting from 1.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
roles
Array of strings >= 1

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get published services by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Secrets

Get all secrets.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
search
string

The search keyword.

gateway_group_id
required
string >= 1

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a secret by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
secret_manager
required
string
Value: "vault"
secret_id
required
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Create or update a secret by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
secret_manager
required
string
Value: "vault"
secret_id
required
string
query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
uri
required
string^[^/]+://([\da-zA-Z.-]+|\[[\da-fA-F:]+\])(:\d...
prefix
required
string
token
required
string

Responses

Request samples

Content type
application/json
{
  • "uri": "string",
  • "prefix": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a secret by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
secret_manager
required
string
Value: "vault"
secret_id
required
string
query Parameters
gateway_group_id
required
string >= 1

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

OpenAPI

Generate an OpenAPI specification to export services.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
scope
string
Enum: "partial" "all"

The scope of the service, which can be partial or all.

Request Body schema: application/json
service_ids
Array of strings

The service ID list.

required
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "service_ids": [
    ],
  • "info": {
    },
  • "servers": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Import services based on OpenAPI Specification.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
non-empty
Array of objects non-empty unique
name
required
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

hosts
Array of strings [ 1 .. 32 ] items unique

The hosts for the service to accept incoming requests.

path_prefix
string [ 1 .. 4096 ] characters ^/

The listening path prefix of the service.

strip_path_prefix
boolean
Default: true

Weather strip the path prefix or not when proxying the request to the upstream.

plugins
object

The key-value pairs which represent the plugins attached on the object.

object

The upstream contains necessary information for the gateway to proxy request to the backend service.

Responses

Request samples

Content type
application/json
{
  • "routes": [
    ],
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "hosts": [
    ],
  • "path_prefix": "string",
  • "strip_path_prefix": true,
  • "plugins": { },
  • "upstream": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Convert OpenAPI Specification to service and route resources.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
raw_openapi
required
string

The raw OpenAPI.

Responses

Request samples

Content type
application/json
{
  • "raw_openapi": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

License

Get the API7 Enterprise license.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Import or update the API7 Enterprise license.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
dry-run
string
Value: "all"

The flag that indicates whether to run the operation in dry-run mode.

Request Body schema: application/json
data
required
string

Encoded license data.

Responses

Request samples

Content type
application/json
{
  • "data": "“xxxx1N-tNaTpttX-NjOdXjyg\""
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Routes

Create a route.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

methods
Array of strings [ 1 .. 9 ] items unique
Items Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "HEAD" "OPTIONS" "TRACE"

The allowed HTTP methods to access the route. If empty, all HTTP methods are allowed.

paths
required
Array of strings [ 1 .. 64 ] items [ items [ 1 .. 4096 ] characters ^/ ]

The URI paths that can be matched to the API.

plugins
object

The key-value pairs which represent the plugins attached on the object.

enable_websocket
boolean

Define whether to enable Websocket for the route.

service_id
required
string^[a-zA-Z0-9-_.]+$

The object ID.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "methods": [
    ],
  • "paths": [
    ],
  • "plugins": { },
  • "enable_websocket": true,
  • "service_id": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all routes.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
service_id
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
search
string

The search keyword.

object non-empty

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a route by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
route_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the route.

query Parameters
object non-empty

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a route by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
route_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the route.

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

methods
Array of strings [ 1 .. 9 ] items unique
Items Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "HEAD" "OPTIONS" "TRACE"

The allowed HTTP methods to access the route. If empty, all HTTP methods are allowed.

paths
required
Array of strings [ 1 .. 64 ] items [ items [ 1 .. 4096 ] characters ^/ ]

The URI paths that can be matched to the API.

plugins
object

The key-value pairs which represent the plugins attached on the object.

enable_websocket
boolean

Define whether to enable Websocket for the route.

service_id
string^[a-zA-Z0-9-_.]+$|^$

The object ID.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "methods": [
    ],
  • "paths": [
    ],
  • "plugins": { },
  • "enable_websocket": true,
  • "service_id": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a route by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
route_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the route.

Request Body schema: application/json
name
string [ 1 .. 255 ] characters

The object name.

object
desc
string

The object description.

methods
Array of strings [ 1 .. 9 ] items unique
Items Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "HEAD" "OPTIONS" "TRACE"

The allowed HTTP methods to access the route. If empty, all HTTP methods are allowed.

paths
Array of strings [ 1 .. 64 ] items [ items [ 1 .. 4096 ] characters ^/ ]

The URI paths that can be matched to the API.

plugins
object

The key-value pairs which represent the plugins attached on the object.

enable_websocket
boolean

Define whether to enable Websocket for the route.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "labels": {
    },
  • "desc": "string",
  • "methods": [
    ],
  • "paths": [
    ],
  • "plugins": { },
  • "enable_websocket": true
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a route by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
route_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the route.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

SSLs

Create a SSL certificate.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
One of
snis
Array of strings

The SNI list for matching the SSL certificate.

required
string or string
Array of strings or strings [ 1 .. 16 ] items
object
type
string
Enum: "server" "client"

The SSL certificate purpose, either client (used for communicating with the upstream) or server (used for communicating with the client)

object
status
integer
Enum: 0 1

The object status. 0 means the object is active while 1 means it's inactive.

required
string or string
Array of strings or strings [ 1 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "snis": [
    ],
  • "cert": "string",
  • "certs": [
    ],
  • "client": {
    },
  • "type": "server",
  • "labels": {
    },
  • "status": 0,
  • "key": "string",
  • "keys": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all SSL certificates.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
search
string

The search keyword.

object non-empty

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a SSL certificate by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
ssl_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the SSL object.

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a SSL certificate by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
ssl_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the SSL object.

query Parameters
gateway_group_id
string >= 1
Request Body schema: application/json
One of
snis
Array of strings

The SNI list for matching the SSL certificate.

required
string or string
Array of strings or strings [ 1 .. 16 ] items
object
type
string
Enum: "server" "client"

The SSL certificate purpose, either client (used for communicating with the upstream) or server (used for communicating with the client)

object
status
integer
Enum: 0 1

The object status. 0 means the object is active while 1 means it's inactive.

required
string or string
Array of strings or strings [ 1 .. 16 ] items

Responses

Request samples

Content type
application/json
{
  • "snis": [
    ],
  • "cert": "string",
  • "certs": [
    ],
  • "client": {
    },
  • "type": "server",
  • "labels": {
    },
  • "status": 0,
  • "key": "string",
  • "keys": [
    ]
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a SSL certificate by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
ssl_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the SSL object.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Consumers

Create an consumer.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
username
required
string [ 1 .. 100 ] characters ^[a-zA-Z0-9_\-]+$

The object name.

plugins
object

The key-value pairs which represent the plugins attached on the object.

desc
string

The object description.

object

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "plugins": { },
  • "desc": "string",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all consumers.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
search
string

The search keyword.

object non-empty

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a consumer by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
consumer_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the consumer.

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a consumer by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
consumer_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the consumer.

query Parameters
gateway_group_id
string >= 1
Request Body schema: application/json
username
required
string [ 1 .. 100 ] characters ^[a-zA-Z0-9_\-]+$

The object name.

plugins
object

The key-value pairs which represent the plugins attached on the object.

desc
string

The object description.

object

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "plugins": { },
  • "desc": "string",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a consumer by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
consumer_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the consumer.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Update a consumer by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
consumer_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the consumer.

Request Body schema: application/json
username
string [ 1 .. 100 ] characters ^[a-zA-Z0-9_\-]+$

The object name.

plugins
object

The key-value pairs which represent the plugins attached on the object.

desc
string

The object description.

object

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "plugins": { },
  • "desc": "string",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Global Rules

Create a global rule.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
plugins
required
object

The key-value pairs which represent the plugins attached on the object.

Responses

Request samples

Content type
application/json
{
  • "plugins": { }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Get all global rules.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
required
string >= 1
page
integer <int64> >= 1

The page number, starting from 1.

page_size
integer <int64> >= 1

The page size. It must be greater than 0.

direction
string
Default: "desc"
Enum: "asc" "desc"

It should be ascending or descending (case-insensitive). By default, it is set to descending.

order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
search
string

The search keyword.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

Get a global rule by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
global_rule_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the global rule.

query Parameters
gateway_group_id
required
string >= 1

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Update a global rule by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
global_rule_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the global rule.

query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
plugins
required
object

The key-value pairs which represent the plugins attached on the object.

Responses

Request samples

Content type
application/json
{
  • "plugins": { }
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Delete a global rule by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
global_rule_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the global rule.

query Parameters
gateway_group_id
required
string >= 1

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Plugin Metadata

Get the plugin metadata.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters
query Parameters
gateway_group_id
required
string >= 1
return_default
boolean
Default: false

When set to true, the default value is returned when plugin metadata is not found.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Update the plugin metadata.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters
query Parameters
gateway_group_id
required
string >= 1
Request Body schema: application/json
object

The plugin metadata description.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Delete the plugin metadata.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters
query Parameters
gateway_group_id
required
string >= 1

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Get the default value of the plugin metadata.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Plugins

Get all plugins.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
has_metadata
boolean
Default: false

A flag that indicates whether to filter plugins with metadata configuration.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get schema definition of all plugins.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters
query Parameters
scope
string
Value: "all"

The scope of the plugin.

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string"
}

Get plugins by plugin name and type.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "key": "string",
  • "warning_msg": "string"
}

List Plugin Catalog.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "key": "string",
  • "warning_msg": "string"
}

Get a Plugin Usage by Name.

Get a Plugin Usage by Name.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
plugin_name
required
string [ 1 .. 64 ] characters

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}

Variables

Get all variables.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "key": "string",
  • "warning_msg": "string"
}

Instances