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

Get gateway by ID

GET
http://localhost:3000/gateway_manager/v1/gateways/:id
GET
/gateway_manager/v1/gateways/:id
$curl http://localhost:3000/gateway_manager/v1/gateways/id \
>     -u "<username>:<password>"
1{
2  "state": "Success",
3  "result": {
4    "_id": "66ff56eb64d3de9f6f930916",
5    "cluster_id": "cluster_1",
6    "description": "example description",
7    "enabled": true,
8    "readonly": true,
9    "groups": [
10      "admins"
11    ],
12    "certificates": [
13      "66ff56c9fcbec46997145abd"
14    ]
15  }
16}
Returns the information about a particular gateway from the database given its ID.
Was this page helpful?
Previous

Get gateway service details

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

idstringRequired
Id for the gateway within the database

Response

Information about a particular gateway
statestringDefaults to Success
resultobject

Errors

500
Internal Server Error