POST
/
tyk
/
apis
/
oas
Create an API with Tyk OAS format.
curl --request POST \
  --url https://{tenant}/tyk/apis/oas \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '{
  "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"
    }
  }
}'
{
  "action": "added",
  "key": "e30bee13ad4248c3b529a4c58bb7be4e",
  "status": "ok"
}

Authorizations

​
X-Tyk-Authorization
string
header
required

Api key

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.

Body

application/json
​
info
object
​
middleware
object
​
server
object
​
upstream
object

Response

API created.

​
action
string
Example:

"modified"

​
key
string
Example:

"b13d928b9972bd18"

​
key_hash
string
​
status
string
Example:

"ok"