GET
/
tyk
/
apis
/
oas
List all APIs in Tyk OAS API format.
curl --request GET \
  --url https://{tenant}/tyk/apis/oas \
  --header 'X-Tyk-Authorization: <api-key>'
[
  {
    "components": {
      "securitySchemes": {
        "bearerAuth": {
          "description": "The API Access Credentials",
          "scheme": "bearer",
          "type": "http"
        }
      }
    },
    "info": {
      "description": "This is a sample OAS.",
      "title": "OAS Sample",
      "version": "1.0.0"
    },
    "openapi": "3.0.3",
    "paths": {
      "/api/sample/users": {
        "get": {
          "operationId": "getUsers",
          "responses": {
            "200": {
              "content": {
                "application/json": {
                  "schema": {
                    "items": {
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                }
              },
              "description": "fetched users"
            }
          },
          "summary": "Get users",
          "tags": [
            "users"
          ]
        }
      }
    },
    "security": [
      {
        "bearerAuth": []
      }
    ],
    "servers": [
      {
        "url": "https://localhost:8080"
      }
    ],
    "x-tyk-api-gateway": {
      "info": {
        "name": "user",
        "state": {
          "active": true
        }
      },
      "server": {
        "listenPath": {
          "strip": true,
          "value": "/user-test/"
        }
      },
      "upstream": {
        "url": "https://localhost:8080"
      }
    }
  }
]

Authorizations

​
X-Tyk-Authorization
string
header
required

Api key

Query Parameters

​
mode
enum<string>

By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response.

Available options:
public

Response

List of API definitions in Tyk OAS format.

​
info
object
​
middleware
object
​
server
object
​
upstream
object