Patch a single OAS API by ID.

curl --request PATCH \
  --url https://{tenant}/api/apis/oas/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "x-tyk-api-gateway": {
    "upstream": {
      "url": "https://httpbin.org/anything"
    }
  }
}
'

import requests

url = "https://{tenant}/api/apis/oas/{apiId}"

payload = { "x-tyk-api-gateway": { "upstream": { "url": "https://httpbin.org/anything" } } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({'x-tyk-api-gateway': {upstream: {url: 'https://httpbin.org/anything'}}})
};

fetch('https://{tenant}/api/apis/oas/{apiId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}/api/apis/oas/{apiId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'x-tyk-api-gateway' => [
        'upstream' => [
                'url' => 'https://httpbin.org/anything'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/merge-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}/api/apis/oas/{apiId}"

	payload := strings.NewReader("{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/merge-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenant}/api/apis/oas/{apiId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/merge-patch+json")
  .body("{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/apis/oas/{apiId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "Message": "API updated",
  "Meta": null,
  "Status": "OK"
}

OAS APIs

Patch a single OAS API by ID.

Update a Tyk OAS API.

With application/json, application/x-yaml or multipart/form-data, replace the OpenAPI description and configure x-tyk-api-gateway from the query parameters, as on import. A body containing x-tyk-api-gateway is rejected.

With application/merge-patch+json, apply an RFC 7396 JSON Merge Patch to the unresolved definition a GET returns. null removes a key and arrays are replaced whole. The result is validated and saved as a PUT would be. Send If-Match to make the update conditional; without it, a patch that races another write is retried up to five times.

Fragment references are patched whole: swap one with {"$ref": "fragment://<id>"}, detach it with {"$ref": null, ...} or remove it with null. Patching inside one returns 409.

PATCH

api

apis

oas

{apiId}

Patch a single OAS API by ID.

curl --request PATCH \
  --url https://{tenant}/api/apis/oas/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "x-tyk-api-gateway": {
    "upstream": {
      "url": "https://httpbin.org/anything"
    }
  }
}
'

import requests

url = "https://{tenant}/api/apis/oas/{apiId}"

payload = { "x-tyk-api-gateway": { "upstream": { "url": "https://httpbin.org/anything" } } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({'x-tyk-api-gateway': {upstream: {url: 'https://httpbin.org/anything'}}})
};

fetch('https://{tenant}/api/apis/oas/{apiId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}/api/apis/oas/{apiId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'x-tyk-api-gateway' => [
        'upstream' => [
                'url' => 'https://httpbin.org/anything'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/merge-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}/api/apis/oas/{apiId}"

	payload := strings.NewReader("{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/merge-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenant}/api/apis/oas/{apiId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/merge-patch+json")
  .body("{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/apis/oas/{apiId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n  \"x-tyk-api-gateway\": {\n    \"upstream\": {\n      \"url\": \"https://httpbin.org/anything\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "Message": "API updated",
  "Meta": null,
  "Status": "OK"
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Headers

If-Match

string

The ETag from a GET. If the definition has changed since, the PATCH returns 412. * matches any version.

Path Parameters

apiId

string

required

ID of the API you want to patch.

Query Parameters

upstreamURL

string

Upstream URL for the API.

listenPath

string

Listen path for the API.

customDomain

string

Custom domain for the API.

allowList

boolean

Enable allowList middleware for all endpoints.

Example:

true

validateRequest

boolean

Enable validateRequest middleware for all endpoints having a request body with media type application/json.

Example:

true

mockResponse

boolean

Enable mockResponse middleware for all endpoints having responses configured.

Example:

true

authentication

boolean

Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API.

Example:

true

Body

The content of the file should be the OpenAPI document in JSON or YAML format.

The body is of type object.

Response

Patched API.

string

Message

string

Install

Helm Charts

Architecture & Scaling

Configure for Production

Automate (API as Code)

Upgrade & Troubleshoot

Reference

Patch a single OAS API by ID.

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response