Proxy¶

List API proxies for an organization or fetch a specific proxy by name, including endpoints and metadata.

Authentication

All methods require a valid Platform API key in the x-yappes-key header.

Base URL

Substitute the sample host https://platformapi.enterprise-xyz.com with the Platform API URL configured for your Yappes organization, since the host value changes depending on the organization and deployment setup.

REST Resources¶

Resource	Methods
organizations.apis	list, get

Resource: organizations.apis¶

API proxy discovery within an organization.

Platform API — List API Proxies¶

Lists all APIs (proxies) for an organization, including endpoint resources and metadata.

HTTP request¶

GET https://platformapi.enterprise-xyz.com/v1/organizations/{orgReferenceId}/apis

Path parameters¶

Parameter	Type	Description
`orgReferenceId`	string	Required. Organization reference (id, reference name, or organization name).

Query parameters¶

None. Query flags such as includeRevisions are not currently supported.

Request body¶

The request body must be empty.

Response body¶

If successful (200), the response body is as follows. Returns an empty proxies array when the organization has no APIs.

{
  "proxies": [
    {
      "apiId": "API-F0F6C9F1",
      "name": "banking-api",
      "baseUrl": "https://upstream.example.com",
      "yappesBaseUrl": "http://banking-api",
      "metaData": {
        "createdAt": "2024-06-03T10:23:20.000Z",
        "lastModifiedAt": "2024-06-04T08:03:20.000Z",
        "subType": "PROXY"
      },
      "resources": [
        {
          "endPointName": "getAccounts",
          "endPoint": "/accounts",
          "method": "GET"
        }
      ]
    }
  ]
}

Errors¶

HTTP status	Condition
`404`	Organization not found.
`500`	Internal error.

Authorization¶

Requires a valid x-yappes-key header.

Platform API — Get API Proxy by Name¶

Gets a specific API proxy by proxy name. The proxyName path segment is matched against the gateway URL as http://{proxyName}.