PATCH
/
api
/
apis
/
streams
/
{apiId}
Patch a single Streams API by ID.
curl --request PATCH \
  --url https://{tenant}/api/apis/streams/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "The API Access Credentials",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "This is a sample Streams API.",
    "title": "Streams Sample",
    "version": "1.0.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/api/sample/users": {
      "get": {
        "operationId": "getUsersSample",
        "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-six/"
      }
    },
    "upstream": {
      "url": "https://localhost:8080"
    }
  },
  "x-tyk-streaming": {
    "streams": {
      "stream1": {
        "input": {
          "kafka": {
            "addresses": [
              "localhost:9093"
            ],
            "auto_replay_nacks": true,
            "checkpoint_limit": 1024,
            "consumer_group": "group1",
            "target_version": "3.3.0",
            "topics": [
              "instrument.json.AMZN",
              "instrument.json.GOOG"
            ]
          }
        },
        "output": {
          "broker": {
            "outputs": [
              {
                "stdout": {
                  "codec": "lines"
                }
              },
              {
                "http_server": {
                  "allowed_verbs": [
                    "GET"
                  ],
                  "path": "/one",
                  "stream_path": "/sse",
                  "ws_path": "/ws"
                }
              }
            ],
            "pattern": "fan_out"
          }
        }
      }
    }
  }
}'
{
  "Message": "API updated",
  "Meta": null,
  "Status": "OK"
}

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Headers

Content-Type
enum<string>
required

Content type for streams endpoints should be application/vnd.tyk.streams.oas

Available options:
application/vnd.tyk.streams.oas

Path Parameters

apiId
string
required

ID of the API you want to patch.

Query Parameters

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 format.

x-tyk-api-gateway
object
x-tyk-streaming
object

Response

Patched API.

ID
string
Message
string
Meta
any
Status
string