list_outbound_apis #

View this page as Markdown

On this page

Generated automatically from the published contract sources.

A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/list_outbound_apis, with a bearer credential and the action's payload as the JSON body. It also accepts GET. An MCP connection lists this action as the tool tzcloud_list_outbound_apis.

OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).

Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

Contract description #

List your account's declared upstreams: name, base URL, credential name, auth form, and the sdk_settings an unchanged client reads. last_call, when present, describes the latest HTTP call the gateway attempted to forward for that upstream and its bound application in the past seven days.

Access and action metadata #

{
  "name": "list_outbound_apis",
  "resource": "upstream",
  "tier": "observe",
  "surface": "tzcloud",
  "addresses": [
    "tzcloud"
  ],
  "product": "cloud",
  "clients": [
    "bearer",
    "browser_session"
  ],
  "summary": "The account's declared upstreams, with the latest eligible upstream call for each declaration when available.",
  "annotations": {
    "readOnlyHint": true,
    "destructiveHint": false,
    "openWorldHint": false,
    "idempotentHint": true
  }
}

MCP catalog entry #

{
  "name": "list_outbound_apis",
  "title": "List outbound APIs",
  "tier": "observe",
  "scenario": "EGW-L0-09",
  "summary": "List your account's declared upstreams: name, base URL, credential name, auth form, and the `sdk_settings` an unchanged client reads. `last_call`, when present, describes the latest HTTP call the gateway attempted to forward for that upstream and its bound application in the past seven days.",
  "owners": [
    "EGW-L0-01",
    "EGW-L0-09"
  ]
}

request #

JSON pointer Description and constraints
"" (root) Type: object

response #

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["contract_version","upstreams"]
/properties/contract_version Required value: 1
/properties/reference The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call.

Type: string
Pattern: ^[0-9a-f]{10}$
/properties/upstreams Type: array
/properties/upstreams/items Type: object
/properties/upstreams/items/properties/application Type: ["string","null"]
/properties/upstreams/items/properties/sdk_settings The declaration's sdk_settings: the settings your unchanged client reads in a deployed container, as declared. Null where the declaration has none.

Type: ["object","null"]
/properties/upstreams/items/properties/last_call The latest HTTP call in the past seven days that the gateway attempted to forward for this declaration's upstream and the account's own bound application. Excludes CONNECT tunnels and calls refused before forwarding. Omitted if no such call exists.

Type: object
Additional properties: false
Required fields: ["at","outcome","status"]
/properties/upstreams/items/properties/last_call/properties/at The recorded time of the call in UTC, in ISO 8601 format.

Type: string
/properties/upstreams/items/properties/last_call/properties/outcome The outcome recorded by the gateway for the call.

Type: string
Allowed values: ["passed","client_disconnected","refused_bounds","upstream_unreachable","egress_timeout"]
/properties/upstreams/items/properties/last_call/properties/status The HTTP status the gateway received from the upstream. Null if no HTTP response reached the gateway.

Type: ["integer","null"]
/properties/detail Type: string

Complete payload contract #

{
  "request": {
    "type": "object",
    "properties": {}
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "upstreams"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "reference": {
        "type": "string",
        "pattern": "^[0-9a-f]{10}$",
        "description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call."
      },
      "upstreams": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "application": {
              "type": [
                "string",
                "null"
              ]
            },
            "sdk_settings": {
              "type": [
                "object",
                "null"
              ],
              "description": "The declaration's `sdk_settings`: the settings your unchanged client reads in a deployed container, as declared. Null where the declaration has none."
            },
            "last_call": {
              "type": "object",
              "description": "The latest HTTP call in the past seven days that the gateway attempted to forward for this declaration's upstream and the account's own bound application. Excludes CONNECT tunnels and calls refused before forwarding. Omitted if no such call exists.",
              "additionalProperties": false,
              "required": [
                "at",
                "outcome",
                "status"
              ],
              "properties": {
                "at": {
                  "type": "string",
                  "description": "The recorded time of the call in UTC, in ISO 8601 format."
                },
                "outcome": {
                  "type": "string",
                  "enum": [
                    "passed",
                    "client_disconnected",
                    "refused_bounds",
                    "upstream_unreachable",
                    "egress_timeout"
                  ],
                  "description": "The outcome recorded by the gateway for the call."
                },
                "status": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "description": "The HTTP status the gateway received from the upstream. Null if no HTTP response reached the gateway."
                }
              }
            }
          }
        }
      },
      "detail": {
        "type": "string"
      }
    }
  }
}

Shared contracts #