For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd a new certificate
        • GETCheck if a specific gateway connection is healthy
        • POSTCreate a new gateway
        • POSTCreate a new service group
        • DELDelete a certificate by ID
        • DELDelete a gateway by ID
        • DELDelete service group
        • GETGet a certificate by its ID
        • GETGet gateway by ID
        • GETGet gateway service details
        • GETGet service group by ID
        • GETList all actively connected gateways
        • GETList all certificates
        • GETList all gateways
        • GETList all service groups
        • GETList all services
        • POSTRun a gateway service
        • GETSimple health check
        • GETThe version of app-gateway_manager
        • PUTUpdate a certificate by ID
        • PUTUpdate gateway
        • PATCHUpdate service group
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceGateway Manager

List all gateways

GET
http://localhost:3000/gateway_manager/v1/gateways
GET
/gateway_manager/v1/gateways
$curl http://localhost:3000/gateway_manager/v1/gateways \
> -u "<username>:<password>"
1{
2 "state": "Success",
3 "results": [
4 {
5 "_id": "66ff56eb64d3de9f6f930916",
6 "cluster_id": "cluster_1",
7 "description": "example description",
8 "enabled": true,
9 "readonly": true,
10 "groups": [
11 "admins"
12 ],
13 "certificates": [
14 "66ff56c9fcbec46997145abd"
15 ]
16 }
17 ]
18}
Returns information about all of the gateways that a user has access to.
Was this page helpful?
Previous

List all service groups

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

A list of all gateways that the user has access to
statestring
resultslist of objects

Errors

500
Internal Server Error