Skip to main content
POST
Create OAS API.

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

base_api_id
string

The base API which the new version will be linked to.

base_api_version_name
string

The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name.

new_version_name
string

The version name of the created version.

set_default
boolean

If true, the new version is set as default version.

templateID
string

The Asset ID of template applied while creating or importing an OAS API.

Body

The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3

openapi
string
required
Pattern: ^3\.0\.\d(-.+)?$
info
object
required
paths
object
required
externalDocs
object
servers
object[]
security
object[]
tags
object[]
components
object
x-tyk-api-gateway
object

Response

OAS created.

ID
string
Message
string
Meta
any
Status
string