Skip to main content
GET
/
api
/
apis
/
oas
/
{apiId}
/
export
Export OAS API.
curl --request GET \
  --url https://{tenant}/api/apis/oas/{apiId}/export \
  --header 'Authorization: Bearer <token>'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Headers

​
Content-Type
enum<string>

Content type of the fetched data. The endpoint returns data in JSON format if Content-Type header is empty.

Available options:
application/json,
application/x-yaml

Path Parameters

​
apiId
string
required

ID of the API you want to export.

Query Parameters

​
mode
enum<string>

Mode of OAS export, by default mode could be empty which means to export OAS spec including OAS Tyk extension. When mode=public, OAS spec excluding Tyk extension is exported.

Available options:
public

Response

Fetched successfully.

The response is of type file.