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

Run a gateway service

POST
http://localhost:3000/gateway_manager/v1/services/run
POST
/gateway_manager/v1/services/run
$curl -X POST http://localhost:3000/gateway_manager/v1/services/run \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1{
2 "state": "Success",
3 "message": "Running my-tofu-service on cluster_1",
4 "result": {
5 "_id": "671289cc62db5c56f3f799b8",
6 "job_id": "20ae2dd7cf1c43aab817556a",
7 "data": "debe9024-52ee-4b39-8c49-96567ff925e4"
8 }
9}
Runs an IAG5 service given its name and any parameters passed to the service itself.
Was this page helpful?
Previous

Simple health check

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
serviceNamestringOptional
clusterIdstringOptional
paramsobjectOptional

Response

An object with an Id to the job running the service
statestring
messagestring
resultobject

Errors

500
Internal Server Error