Skip to main content
API docs by Redocly

API7 Enterprise Admin APIs (3.2.11.5)

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

Get all gateway instances.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
gateway_group_id
string >= 1
order_by
string
Default: "last_heartbeat_time"
Enum: "created_at" "last_heartbeat_time"
status
string
Enum: "Healthy" "OutOfSync" "LostConnection" "Offline"

The value of the instance status.

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.

search
string

The search keyword.

Responses

Response samples

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

Calculate the number of instances in different states.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
field
required
string
Value: "status"
query Parameters
gateway_group_id
string >= 1
search
string

The search keyword.

Responses

Response samples

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

Get all gateway instances cores.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Export the gateway instance core usage.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
begin_at
required
integer <int64>

The start time of gateway instance core usage.

end_at
required
integer <int64>

The end time of gateway instance core usage.

Responses

Response samples

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

Create a token for the gateway instance.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
query Parameters
only_token
boolean

The response only contains a token string but not an encoded JSON Web Token (JWT).

Responses

Response samples

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

Users

Get all users.

Authorizations:
APIKeyAuthBasicAuth
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
login_option_name
Array of strings >= 1

Responses

Response samples

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

Get a user by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
user_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

The user ID.

Responses

Response samples

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

Delete a user by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
user_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

The user ID.

Responses

Response samples

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

Reset the password to the default value.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
user_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

The user ID.

Request Body schema: application/json
password
required
string [ 1 .. 128 ] characters

The password of the user.

Responses

Request samples

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

Response samples

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

Get details of a user.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Update a user.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
first_name
required
string [ 1 .. 150 ] characters
last_name
required
string [ 1 .. 150 ] characters

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

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

Invite a user.

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

The username of the user.

password
required
string [ 1 .. 128 ] characters

The password of the user.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

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

Update the user password.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
old_password
string [ 1 .. 128 ] characters
new_password
required
string [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Response samples

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

Log in to API7 Enterprise using the username and password.

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

The username of the user.

password
required
string [ 1 .. 128 ] characters

The password of the user.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

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

Log out from API7 Enterprise using the username and password.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Analyze the impact of removing specified resource tags on RBAC.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
Array (non-empty)
id
required
string^[a-zA-Z0-9-_.]+$

The object ID.

required
object non-empty

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Update assigned roles for a specific user.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
user_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

The user ID.

Request Body schema: application/json
Array of objects [ 1 .. 32 ] items
Array ([ 1 .. 32 ] items)
role_id
required
string
scopes
Array of strings

The scope of role effectiveness. The array contains the IDs of resources, such as services or gateway groups.

Array of objects[ items = 1 properties ]

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

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

Log in using the OIDC (OpenID Connect) protocol.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Log out using the OIDC (OpenID Connect) protocol.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Callback APIs from the identity server.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
state
required
string

The field of the OIDC protocol.

code
required
string

The field of the OIDC protocol.

Responses

Response samples

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

Log in to API7 Enterprise using the username and password.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
Request Body schema: application/json
username
required
string [ 1 .. 128 ] characters

The username of the user.

password
required
string [ 1 .. 128 ] characters

The password of the user.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

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

Log out from API7 Enterprise using the username and password.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

Log in using the OIDC provider.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

Log in using the OIDC provider.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
query Parameters
state
required
string

The field of the OIDC protocol.

code
required
string

The field of the OIDC protocol.

Responses

Response samples

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

Log out using the OIDC provider.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

SAML login, will redirect to IDP and callback to SP(dashboard)

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
query Parameters
redirect_uri
string non-empty ^/

Path to be redirected after callback

Responses

Response samples

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

SAML Logout, will redirect to IDP and callback to SP(dashboard)

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
query Parameters
redirect_uri
string non-empty ^/

Path to be redirected after callback

Responses

Response samples

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

SAML ACS/SLO callback, from IDP callback to SP(dashboard)

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
Request Body schema: application/x-www-form-urlencoded
SAMLResponse
required
string

Base64 encoded SAML response

RelayState
string

State information to be relayed with the response

Responses

Response samples

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

SAML ACS/SLO callback, from IDP callback to SP(dashboard)

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
query Parameters
SAMLResponse
required
string

Base64 encoded SAML response

RelayState
string

State information to be relayed with the response

Responses

Response samples

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

SAML ACS/SLO callback, from IDP callback to SP(dashboard)

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
Request Body schema: application/x-www-form-urlencoded
SAMLResponse
required
string

Base64 encoded SAML response

RelayState
string

State information to be relayed with the response

Responses

Response samples

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

SP metadata

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

RBAC

Get all roles.

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.

Responses

Response samples

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

Create a role.

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

The role name.

desc
string <= 256 characters

The object description.

permissions
required
Array of strings

The permission settings of the role.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "desc": "string",
  • "permissions": [
    ]
}

Response samples

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

Get details of a role by role ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
role_id
required
string >= 1

Responses

Response samples

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

Update a role by role ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
role_id
required
string >= 1
Request Body schema: application/json
name
string

The role name.

desc
string <= 256 characters

The object description.

permissions
Array of strings

The permission settings of the role.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "desc": "string",
  • "permissions": [
    ]
}

Response samples

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

Delete a role by role ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
role_id
required
string >= 1

Responses

Response samples

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

Get all permissions.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Prometheus Proxy

Get data from Prometheus.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
prometheus_path
required
string
Example: api/v1/query_range?query=xxx&start=1684722195&end=1684723995&step=15

The path to the Prometheus API.

Responses

Response samples

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

Get data from Prometheus (with post).

Authorizations:
APIKeyAuthBasicAuth
path Parameters
prometheus_path
required
string
Example: api/v1/query_range?query=xxx&start=1684722195&end=1684723995&step=15

The path to the Prometheus API.

Request Body schema: application/x-www-form-urlencoded
property name*
additional property
any

Responses

Response samples

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

Data Plane Heartbeat

Send a heartbeat to the data plane.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
instance_id
required
string^[a-zA-Z0-9-_.]+$

The gateway instance ID.

hostname
required
string

The hostname of the gateway instance.

ip
string

The IP address of the gateway instance.

version
required
string

The version of the gateway instance.

ports
required
Array of integers non-empty unique

The listening ports of the gateway instance.

conf_server_revision
required
string

The configuration version currently used by the data plane.

cores
integer

The number of DP cores.

Responses

Request samples

Content type
application/json
{
  • "instance_id": "string",
  • "hostname": "string",
  • "ip": "string",
  • "version": "string",
  • "ports": [
    ],
  • "conf_server_revision": "string",
  • "cores": 0
}

Response samples

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

Data Plane Metrics

Generate data plane metrics.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
instance_id
required
string^[a-zA-Z0-9-_.]+$

The gateway instance ID.

truncated
boolean

Whether to truncate the reported metrics due to exceeding the single report size limit.

metrics
required
string

Format the text in Prometheus metric format.

Responses

Request samples

Content type
application/json
{
  • "instance_id": "string",
  • "truncated": true,
  • "metrics": "string"
}

Response samples

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

Alert Policy

Get all alert policies.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
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.

search
string

The search keyword.

Responses

Response samples

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

Create an alert policy.

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

The policy name.

description
string [ 1 .. 1024 ] characters

The policy description.

severity
string
Default: "medium"
Enum: "high" "medium" "low"

The alert severity level.

scope
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "severity": "high",
  • "scope": [
    ]
}

Response samples

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

Get an alert policy by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
alert_policy_id
required
string

Responses

Response samples

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

Delete an alert policy by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
alert_policy_id
required
string

Responses

Response samples

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

Update an alert Policy by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
alert_policy_id
required
string
Request Body schema: application/json
name
string

The alert policy name.

description
string [ 1 .. 1024 ] characters

The alert policy description.

scope
Array of strings non-empty
enable
boolean
Default: false

Whether the alert policy is enabled.

title
string [ 1 .. 128 ] characters

The alert policy title.

detail
string [ 1 .. 128 ] characters

The alert policy details.

check_interval
integer [ 60 .. 86400 ]

The check interval for the alert policy. The unit is second.

severity
string
Default: "medium"
Enum: "high" "medium" "low"

The alert severity level.

webhook_templates
Array of strings [ 0 .. 10 ] items

The alert Webhook template refers.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": [
    ],
  • "enable": false,
  • "title": "string",
  • "detail": "string",
  • "check_interval": 60,
  • "severity": "high",
  • "webhook_templates": [
    ]
}

Response samples

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

Update an alert policy by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
alert_policy_id
required
string
Request Body schema: application/json
name
string

The alert policy name.

description
string [ 1 .. 1024 ] characters

The alert policy description.

scope
Array of strings non-empty
enable
boolean
Default: false

Whether the alert policy is enabled.

title
string [ 1 .. 128 ] characters

The alert policy title.

detail
string [ 1 .. 128 ] characters

The alert policy details.

check_interval
integer [ 60 .. 86400 ]

The check interval for the alert policy. The unit is second.

severity
string
Default: "medium"
Enum: "high" "medium" "low"

The alert severity level.

webhook_templates
Array of strings [ 0 .. 10 ] items

The alert Webhook template refers.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": [
    ],
  • "enable": false,
  • "title": "string",
  • "detail": "string",
  • "check_interval": 60,
  • "severity": "high",
  • "webhook_templates": [
    ]
}

Response samples

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

Update alert policy triggers by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
alert_policy_id
required
string
Request Body schema: application/json
trigger_logical_operator
string
Enum: "All" "Any"
Array of objects or objects or objects [ 1 .. 64 ] items

Responses

Request samples

Content type
application/json
{
  • "trigger_logical_operator": "All",
  • "trigger_conditions": [
    ]
}

Response samples

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

Alert Webhook Templates

Get all alert Webhook templates.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
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.

search
string

The search keyword.

Responses

Response samples

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

Create an alert Webhook template.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
name
required
string [ 1 .. 20 ] characters
description
string [ 0 .. 255 ] characters
url
required
string [ 1 .. 1024 ] characters

The Webhook URL.

method
string
Default: "POST"
Value: "POST"

The HTTP method of the Webhook request.

skip_tls_verify
required
boolean
Default: false

Whether to skip TLS verification.

Array of objects [ 1 .. 16 ] items

Extra HTTP headers to take when sending requests.

template
required
string

The alert message template, which supports the Go syntax.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "method": "POST",
  • "skip_tls_verify": false,
  • "headers": [
    ],
  • "template": "string"
}

Response samples

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

Get an alert Webhook template by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
webhook_template_id
required
string

Responses

Response samples

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

Update an alert Webhook template by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
webhook_template_id
required
string
Request Body schema: application/json
name
required
string [ 1 .. 20 ] characters
description
string [ 0 .. 255 ] characters
url
required
string [ 1 .. 1024 ] characters

The Webhook URL.

method
string
Default: "POST"
Value: "POST"

The HTTP method of the Webhook request.

skip_tls_verify
required
boolean
Default: false

Whether to skip TLS verification.

Array of objects [ 1 .. 16 ] items

Extra HTTP headers to take when sending requests.

template
required
string

The alert message template, which supports the Go syntax.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "method": "POST",
  • "skip_tls_verify": false,
  • "headers": [
    ],
  • "template": "string"
}

Response samples

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

Delete an alert Webhook template by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
webhook_template_id
required
string

Responses

Response samples

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

Get all alert Webhook template refers.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
webhook_template_id
required
string

Responses

Response samples

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

Alert Policy History

Get all alert history.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
order_by
string
Default: "updated_at"
Enum: "created_at" "updated_at"
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.

search
string

The search keyword.

Responses

Response samples

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

Audit Logs

Get all audit logs.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
event_type
string
operator_id
string

The user ID of the operator.

resource_id
string
start_at
integer
end_at
integer
order_by
string
Default: "event_time"
Value: "event_time"
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.

Responses

Response samples

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

Get all event types of audit logs.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Export all audit logs.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
event_type
string
operator_id
string

The user ID of the operator.

resource_id
string
start_at
integer
end_at
integer
format
required
string
Enum: "json" "csv"

Responses

Tokens

Create a token.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
name
required
string <= 40 characters

The token name.

expires_at
required
integer <int64>

The expiration time of the token.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expires_at": 0
}

Response samples

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

Get all tokens.

Authorizations:
APIKeyAuthBasicAuth
query Parameters
order_by
string
Default: "created_at"
Enum: "created_at" "updated_at" "expires_at"
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.

search
string

The search keyword.

Responses

Response samples

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

Get a token by ID.

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

The unique identifier of the token.

Responses

Response samples

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

Update a token by ID.

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

The unique identifier of the token.

Request Body schema: application/json
name
required
string <= 40 characters

The token name.

Responses

Request samples

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

Response samples

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

Delete a token by ID.

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

The unique identifier of the token.

Responses

Response samples

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

Regenerate a token.

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

The unique identifier of the token.

Request Body schema: application/json
expires_at
required
integer <int64>

The expiration time of the token.

Responses

Request samples

Content type
application/json
{
  • "expires_at": 0
}

Response samples

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

Gateway Groups

Get all gateway groups.

Authorizations:
APIKeyAuthBasicAuth
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"
search
string

The search keyword.

object non-empty
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
}

Create a gateway group.

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

The object name.

description
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "labels": {
    }
}

Response samples

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

Count resources for the gateway group.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
resource_type
required
string
Enum: "ssl" "consumer" "gateway_instance"

Responses

Response samples

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

Delete a gateway group by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Update a gateway group by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters

The object name.

description
required
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "labels": {
    }
}

Response samples

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

Get a gateway group by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Get all published services in Gateway Group.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
query Parameters
runtime_type
string
Enum: "normal" "canary"
unhealthy_nodes
Array of strings
Items Enum: "unhealthy_nodes_exists" "no_unhealthy_nodes"
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" "publish_time"
search
string

The search keyword.

Responses

Response samples

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

Get a published service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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"
}

Delete a published service by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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"
}

Get all permitted users for published service.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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 all versions of published services by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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.

order_by
string
Default: "publish_time"
Value: "publish_time"

Responses

Response samples

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

Get all service runtime configurations by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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 service runtime configurations by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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
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.

object
status
integer
Enum: 0 1

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

plugins
object

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

Responses

Request samples

Content type
application/json
{
  • "hosts": [
    ],
  • "path_prefix": "string",
  • "strip_path_prefix": true,
  • "upstreams": {
    },
  • "status": 0,
  • "plugins": { }
}

Response samples

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

Get all permitted users.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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
}

Data Plane Certificates

Issue a data plane certificate.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Service Registry

Get all service registries.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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_connect_time"
search
string

The search keyword.

Responses

Response samples

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

Create a service registry.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
Request Body schema: application/json
One of
name
string [ 1 .. 255 ] characters

The object name.

description
string
object
type
required
string
Value: "kubernetes"

The kubernetes service type.

required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "health_check": {
    },
  • "type": "nacos",
  • "nacos_config": {
    }
}

Response samples

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

Get details of a service registry by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Update a service registry by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
Request Body schema: application/json
One of
name
string [ 1 .. 255 ] characters

The object name.

description
string
object
type
required
string
Value: "kubernetes"

The kubernetes service type.

required
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "health_check": {
    },
  • "type": "nacos",
  • "nacos_config": {
    }
}

Response samples

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

Delete a service registry by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Get all services connected to a service registry.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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" "publish_time"

Responses

Response samples

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

Get all internal services under a service registry (kubernetes).

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Get all Nacos namespaces.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335

Responses

Response samples

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

Get all groups under a Nacos namespace.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
nacos_namespace
required
string >= 1
Example: public

Responses

Response samples

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

Get all services under a Nacos group.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
nacos_namespace
required
string >= 1
Example: public
nacos_group
required
string >= 1
Example: DEFAULT_GROUP

Responses

Response samples

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

Get all Nacos namespaces.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
nacos_namespace
required
string >= 1
Example: public
nacos_group
required
string >= 1
Example: DEFAULT_GROUP
nacos_service
required
string >= 1
Example: api7ee3-keycloak

Responses

Response samples

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

Get health check history of a service registry.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
service_registry_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
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: "connect_time"
Value: "connect_time"
status
Array of strings
Items Enum: "healthy" "lost_connection"
search
string

The search keyword.

Responses

Response samples

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

Service Versions

Get all service versions.

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

The unique identifier of the service version.

Responses

Response samples

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

Get service versions for all routes.

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

The unique identifier of the service version.

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"

Responses

Response samples

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

Get the service version for a specified route.

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

The unique identifier of the service version.

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

The unique identifier of the route version.

Responses

Response samples

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

Get the service version name.

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

The unique identifier of the service.

version
required
string

Responses

Response samples

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

Labels

Get all labels.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
resource_type
required
string
Enum: "gateway_group" "consumer" "ssl" "service" "route"

Responses

Response samples

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

System Settings

Update system settings.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
control_plane_address
Array of strings [ 0 .. 32 ] items unique
enable_mtls
boolean

Enable mtls between data plane and control plane.

Responses

Request samples

Content type
application/json
{
  • "control_plane_address": [
    ],
  • "enable_mtls": true
}

Response samples

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

Get all system settings.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Update SCIM settings.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
enable_scim
boolean

Enable SCIM endpoint.

Responses

Request samples

Content type
application/json
{
  • "enable_scim": true
}

Response samples

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

Get SCIM settings.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Generate SCIM Token.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Login Option

Get a login option by ID.

Get a login option by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

Update a login option by ID.

Update a login option by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
Request Body schema: application/json
name
required
string
logo
string

The base64 logo image.

disable
boolean
Default: false

Whether to disable the login option.

provider_type
string
Enum: "ldap" "oidc" "saml" "cas" "built_in"

The login option type.

object
object
object
object
Array of objects

A list of role mappings defining operations and conditions under which roles are applied.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "disable": false,
  • "provider_type": "ldap",
  • "oidc_config": {},
  • "saml_config": {
    },
  • "ldap_config": {
    },
  • "cas_config": {
    },
  • "role_mapping": [
    ]
}

Response samples

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

Update a login option by ID.

Update a login option by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string
Request Body schema: application/json
name
required
string
logo
string

The base64 logo image.

disable
boolean
Default: false

Whether to disable the login option.

provider_type
string
Enum: "ldap" "oidc" "saml" "cas" "built_in"

The login option type.

object
object
object
object
Array of objects

A list of role mappings defining operations and conditions under which roles are applied.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "disable": false,
  • "provider_type": "ldap",
  • "oidc_config": {},
  • "saml_config": {
    },
  • "ldap_config": {
    },
  • "cas_config": {
    },
  • "role_mapping": [
    ]
}

Response samples

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

Delete a login option by ID.

Delete a login option by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
login_option_id
required
string

Responses

Response samples

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

Get all login options.

Get all login options.

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.

name
string

Name is the name of the resource.

Responses

Response samples

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

Create a login option.

Create a login option.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
name
required
string
logo
string

The base64 logo image.

disable
boolean
Default: false

Whether to disable the login option.

provider_type
string
Enum: "ldap" "oidc" "saml" "cas" "built_in"

The login option type.

object
object
object
object
Array of objects

A list of role mappings defining operations and conditions under which roles are applied.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "disable": false,
  • "provider_type": "ldap",
  • "oidc_config": {},
  • "saml_config": {
    },
  • "ldap_config": {
    },
  • "cas_config": {
    },
  • "role_mapping": [
    ]
}

Response samples

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

Provider - APIProducts

Create an APIProduct.

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

The object name.

raw_openapi
required
string non-empty

The content of the openapi yaml file.

server_url
required
string non-empty

The server url, if its not defines on the openapi file, the user should specified it.

Responses

Request samples

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

Response samples

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

Get all APIProducts.

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.

Responses

Response samples

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

Get an APIProduct by ID.

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

the unique identifier of the api product.

Responses

Response samples

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

Update an APIProduct by ID.

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

the unique identifier of the api product.

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

The object name.

raw_openapi
required
string non-empty

The content of the openapi yaml file.

server_url
required
string non-empty

The server url, if its not defines on the openapi file, the user should specified it.

Responses

Request samples

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

Response samples

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

Delete an APIProduct by ID.

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

the unique identifier of the api product.

Responses

Response samples

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

Developer - APIProducts

Get all APIProducts.

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.

Responses

Response samples

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

Get an APIProduct by ID.

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

the unique identifier of the api product.

Responses

Response samples

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

Data Plane HealthcheckStatus

Report the health check result data of each node based on the health check configuration of the gateway instance

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
instance_id
required
string non-empty

The gateway instance ID.

Array of objects

Item is a node healthcheck data.

Responses

Request samples

Content type
application/json
{
  • "instance_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "data": [
    ]
}

Response samples

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

Healthcheck Status

Get healthcheck status for the upstream which related to the service.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
gateway_group_id
required
string >= 1
Example: 86fb9981-d9d2-4555-9df8-91ae92129335
service_id
required
string^[a-zA-Z0-9-_.]+$

The unique identifier of the service.

Responses

Response samples

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

Schema

Get core APIs schema

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

Content type
application/json
{
  • "value": { },
  • "key": "string",
  • "warning_msg": "string",
  • "service": { },
  • "route": { },
  • "consumer": { },
  • "global_rule": { },
  • "ssl": { },
  • "secret": { },
  • "plugin_metadata": { }
}

/api/schema/plugins

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

System Infos

Get all system infos.

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Common

Get Dashboard Version

Authorizations:
APIKeyAuthBasicAuth

Responses

Response samples

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

Custom Plugins

List Custom Plugins

List Custom Plugins

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.

name
string

Name is the name of the resource.

Responses

Response samples

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

Create a Custom Plugin.

Create a Custom Plugin.

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

The source code file for the plugin.

catalog
required
string

The catalog to which the plugin belongs, such as 'Traffic' or 'Observability'.

description
required
string

A brief description of the plugin.

documentation_link
required
string

A link to the plugin's documentation.

author
required
string
logo
string

An optional logo for the plugin.

Responses

Request samples

Content type
application/json
{}

Response samples

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

Get a Custom Plugin by ID.

Get a Custom Plugin by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
custom_plugin_id
required
string

Responses

Response samples

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

Update a Custom Plugin by ID.

Update a Custom Plugin by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
custom_plugin_id
required
string
Request Body schema: application/json
source_code
required
string

The source code file for the plugin.

catalog
required
string

The catalog to which the plugin belongs, such as 'Traffic' or 'Observability'.

description
required
string

A brief description of the plugin.

documentation_link
required
string

A link to the plugin's documentation.

author
required
string
logo
string

An optional logo for the plugin.

Responses

Request samples

Content type
application/json
{}

Response samples

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

Delete a Custom Plugin by ID.

Delete a Custom Plugin by ID.

Authorizations:
APIKeyAuthBasicAuth
path Parameters
custom_plugin_id
required
string

Responses

Response samples

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

Parse Custom Plugin Code.

Parse Custom Plugin Code.

Authorizations:
APIKeyAuthBasicAuth
Request Body schema: application/json
source_code
string

The source code file for the plugin.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": {
    },
  • "key": "string",
  • "warning_msg": "string"
}
API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud
API7 Enterprise
API Portal
Roadmap

Open Source

Apache APISIX
K8s Ingress Controller
wasm-nginx-module
Contributor Graph

Resources

Blog
Documentation
NGINX + Lua
APISIX vs Kong
APISIX vs NGINX

Company

About
Contact
Compliance Standards
Partners
Terms & Privacy
SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2025. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation