---
title: "list_outbound_apis"
description: "Generated reference for the management action list_outbound_apis: its description, access metadata, payload contract, and registration status."
slug: /reference/actions/list-outbound-apis
order: 52
visibility: public
redirects_from: ["/reference/actions/list-upstreams"]
---

# list\_outbound\_apis

Generated automatically from the [published contract sources](/cloud/reference/about/#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](/cloud/concepts/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

```json
{
  "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

```json
{
  "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<br>Required fields: \["contract\_version","upstreams"\] |
| /<wbr>properties/<wbr>contract\_version | Required value: 1 |
| /<wbr>properties/<wbr>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\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{10\}$ |
| /<wbr>properties/<wbr>upstreams | Type: array |
| /<wbr>properties/<wbr>upstreams/<wbr>items | Type: object |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>application | Type: \["string","null"\] |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>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\.<br><br>Type: \["object","null"\] |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>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\.<br><br>Type: object<br>Additional properties: false<br>Required fields: \["at","outcome","status"\] |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>last\_call/<wbr>properties/<wbr>at | The recorded time of the call in UTC, in ISO 8601 format\.<br><br>Type: string |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>last\_call/<wbr>properties/<wbr>outcome | The outcome recorded by the gateway for the call\.<br><br>Type: string<br>Allowed values: \["passed","client\_disconnected","refused\_bounds","upstream\_unreachable","egress\_timeout"\] |
| /<wbr>properties/<wbr>upstreams/<wbr>items/<wbr>properties/<wbr>last\_call/<wbr>properties/<wbr>status | The HTTP status the gateway received from the upstream\. Null if no HTTP response reached the gateway\.<br><br>Type: \["integer","null"\] |
| /<wbr>properties/<wbr>detail | Type: string |

## Complete payload contract

```json
{
  "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

- [Refusals](/cloud/reference/refusals/): every refusal, by surface, with its cause and its remedy
- [schemas/wire\_error\.schema\.json](/cloud/reference/sources/schemas/wire-error-schema/)
- [schemas/wire\_errors\.json](/cloud/reference/sources/schemas/wire-errors/)
- [schemas/action\_payloads\.json](/cloud/reference/sources/schemas/action-payloads/) (includes shared shapes)
- [management\_api\_contract\.md](/cloud/reference/sources/management-api-contract/)
