Skip to main content
Version: 3.0

API doc of Manager API

Manager API directly operates ETCD and provides data management for Apache APISIX, provides APIs for Front-end or other clients.

License: Apache License 2.0

/apisix/admin/migrate/export#

GET#

Summary#

Export a config file for migrate.

Parameters#

None.

Responses#

A file for download.

/apisix/admin/migrate/import#

Summary#

Import the config file for restore config.

POST#

Parameters (FORM)#
NameLocated inDescriptionRequiredSchema
modebody(form)import mode (return, skip or overwrite)Yesstring
filebody(form)file to uploadYesstring
Responses#
CodeDescriptionSchema
0import successApiError
20001Config conflictApiError

/apisix/admin/check_ssl_cert#

POST#

Summary#

verify SSL cert and key.

Parameters#
NameLocated inDescriptionRequiredSchema
certbodycert of SSLYesstring
keybodykey of SSLYesstring
Responses#
CodeDescriptionSchema
0SSL verify passedApiError
defaultunexpected errorApiError

/apisix/admin/check_ssl_exists#

POST#

Summary#

Check whether the SSL exists.

Parameters#
NameLocated inDescriptionRequiredSchema
certbodycert of SSLYesstring
keybodykey of SSLYesstring
Responses#
CodeDescriptionSchema
0SSL existsApiError
defaultunexpected errorApiError

/apisix/admin/consumers#

GET#

Summary#

Return the consumer list according to the specified page number and page size, and can search consumers by username.

Parameters#
NameLocated inDescriptionRequiredSchema
pagequerypage numberNointeger
page_sizequerypage sizeNointeger
usernamequeryusername of consumerNostring
Responses#
CodeDescriptionSchema
0list response[ consumer ]
defaultunexpected errorApiError

/apisix/admin/notexist/routes#

GET#

Summary#

Return result of route exists checking by name and exclude id.

Parameters#
NameLocated inDescriptionRequiredSchema
namequeryname of routeNostring
excludequeryid of route that exclude checkingNostring
Responses#
CodeDescriptionSchema
0route not existsApiError
defaultunexpected errorApiError

/apisix/admin/routes#

GET#

Summary#

Return the route list according to the specified page number and page size, and can search routes by name and uri.

Parameters#
NameLocated inDescriptionRequiredSchema
pagequerypage numberNointeger
page_sizequerypage sizeNointeger
namequeryname of routeNostring
uriqueryuri of routeNostring
labelquerylabel of routeNostring
Responses#
CodeDescriptionSchema
0list response[ route ]
defaultunexpected errorApiError

/apisix/admin/services#

GET#

Summary#

Return the service list according to the specified page number and page size, and can search services by name.

Parameters#
NameLocated inDescriptionRequiredSchema
pagequerypage numberNointeger
page_sizequerypage sizeNointeger
namequeryname of serviceNostring
Responses#
CodeDescriptionSchema
0list response[ service ]
defaultunexpected errorApiError

/apisix/admin/ssl#

GET#

Summary#

Return the SSL list according to the specified page number and page size, and can SSLs search by sni.

Parameters#
NameLocated inDescriptionRequiredSchema
pagequerypage numberNointeger
page_sizequerypage sizeNointeger
sniquerysni of SSLNostring
Responses#
CodeDescriptionSchema
0list response[ ssl ]
defaultunexpected errorApiError

/apisix/admin/upstreams#

GET#

Summary#

Return the upstream list according to the specified page number and page size, and can search upstreams by name.

Parameters#
NameLocated inDescriptionRequiredSchema
pagequerypage numberNointeger
page_sizequerypage sizeNointeger
namequeryname of upstreamNostring
Responses#
CodeDescriptionSchema
0list response[ upstream ]
defaultunexpected errorApiError

/apisix/admin/user/login#

POST#

Summary#

user login.

Parameters#
NameLocated inDescriptionRequiredSchema
usernamebodyuser nameYesstring
passwordbodypasswordYesstring
Responses#
CodeDescriptionSchema
0login successApiError
defaultunexpected errorApiError

Models#

ApiError#

NameTypeDescriptionRequired
codelongresponse codeNo
messagestringresponse messageNo

BaseInfo#

NameTypeDescriptionRequired
create_timelongNo
idobjectNo
update_timelongNo

Consumer#

NameTypeDescriptionRequired
create_timelongNo
descstringNo
idobjectNo
labelsobjectNo
pluginsobjectNo
update_timelongNo
usernamestringNo

LoginInput#

NameTypeDescriptionRequired
passwordstringpasswordNo
usernamestringuser nameNo

Route#

NameTypeDescriptionRequired
create_timelongNo
descstringNo
enable_websocketbooleanNo
filter_funcstringNo
hoststringNo
hosts[ string ]No
idobjectNo
labelsobjectNo
methods[ string ]No
namestringNo
pluginsobjectNo
prioritylongNo
remote_addrstringNo
remote_addrs[ string ]No
scriptobjectNo
service_idobjectNo
service_protocolstringNo
update_timelongNo
upstreamUpstreamDefNo
upstream_idobjectNo
uristringNo
uris[ string ]No
varsobjectNo

SSL#

NameTypeDescriptionRequired
certstringNo
certs[ string ]No
create_timelongNo
exptimelongNo
idobjectNo
keystringNo
keys[ string ]No
labelsobjectNo
snistringNo
snis[ string ]No
statuslongNo
update_timelongNo
validity_endlongNo
validity_startlongNo

Service#

NameTypeDescriptionRequired
create_timelongNo
descstringNo
enable_websocketbooleanNo
idobjectNo
labelsobjectNo
namestringNo
pluginsobjectNo
scriptstringNo
update_timelongNo
upstreamUpstreamDefNo
upstream_idobjectNo

Upstream#

NameTypeDescriptionRequired
checksobjectNo
create_timelongNo
descstringNo
hash_onstringNo
idobjectNo
k8s_deployment_infoobjectNo
keystringNo
labelsobjectNo
namestringNo
nodesobjectNo
pass_hoststringNo
retrieslongNo
service_namestringNo
timeoutobjectNo
typestringNo
update_timelongNo
upstream_hoststringNo

UpstreamDef#

NameTypeDescriptionRequired
checksobjectNo
descstringNo
hash_onstringNo
k8s_deployment_infoobjectNo
keystringNo
labelsobjectNo
namestringNo
nodesobjectNo
pass_hoststringNo
retrieslongNo
service_namestringNo
timeoutobjectNo
typestringNo
upstream_hoststringNo