Tyk API Management

https://tyk.io/docs
Admin
Tyk is a comprehensive API management platform that enables organizations to design, secure,...
Tokens:3,196,413
Snippets:21,122
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Bootstrap the getting started example with make

Source: https://tyk.io/docs/api-management/plugins/overview

Run the make command to bootstrap the getting started example. This compiles the plugin for the first time and downloads all necessary Docker images, taking a few minutes.

```bash
make

```

--------------------------------

### Run example services locally

Source: https://tyk.io/docs/api-management/data-graph

Commands to install dependencies, build, and start the example services. The services run on ports 4000 and 4001.

```bash
cd example-rest-api-for-udg

```

```bash
npm i

```

```bash
npm run build

```

```bash
npm start

```

--------------------------------

### Bootstrap the getting started example

Source: https://tyk.io/docs/api-management/plugins/overview

Run this command from within your newly cloned directory to run the Tyk Stack and compile the sample plugin. This will take a few minutes as dependencies and docker images are downloaded.

```bash
make up-oss && make build

```

--------------------------------

### Run the Golang SSE server

Source: https://tyk.io/docs/advanced-configuration/sse-proxy

Starts the example SSE server on port 8000 as described in the setup steps. Run this command from the directory containing the server.go file.

```bash
go run ./server.go

```

--------------------------------

### Get Plugins Count - Example

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/service-api

Example of getting the total plugin count and logging it.

```go
count, err := ai_studio_sdk.GetPluginsCount(ctx)
if err != nil {
    return err
}

log.Printf("Total plugins: %d", count)
```

--------------------------------

### SDK Installation Command

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/overview

Installs the unified plugin SDK using go get.

```bash
go get github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk
```

--------------------------------

### Example CLI interaction

Source: https://tyk.io/docs/ai-management/ai-studio/ai-cli-app

Example output showing the CLI starting, a user prompt, and the LLM response.

```text
LLM CLI started. Type a prompt and press enter.

You> explain kubernetes in simple terms

LLM> Kubernetes is a system that helps run and manage containers...

```

--------------------------------

### Install Tyk Gateway on Ubuntu via Shell

Source: https://tyk.io/docs/apim/open-source/installation

Commands to install and configure Tyk Gateway on Ubuntu via Shell. Install Redis, import the Ubuntu APT public key, run the setup script with your Redis hostname, and start the Gateway service.

```shell
$ sudo apt-get install -y redis-server

```

```shell
$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927

```

```shell
$ sudo /opt/tyk-gateway/install/setup.sh --listenport=8080 --redishost=<hostname> --redisport=6379 --domain=""

```

```shell
$ sudo service tyk-gateway start

```

--------------------------------

### Project Setup: Create plugin directory and initialize Go module

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/edge-gateway

Commands to create the plugin directory, initialize a Go module, and add the unified SDK dependency.

```bash
# Create plugin directory
mkdir my-gateway-plugin && cd my-gateway-plugin

# Initialize Go module
go mod init github.com/myorg/my-gateway-plugin

# Add unified SDK dependency
go get github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk

```

--------------------------------

### Go example to list tutorials

Source: https://tyk.io/docs/api-reference/tutorials-for-api-products/list-all-tutorials-for-this-api-product

Go example using net/http to GET tutorials for an API product. Replace {product_id} and <api-key> as needed. The response body is printed to stdout.

```go
package main

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

func main() {

	url := "http://localhost:3001/portal-api/products/{product_id}/docs?per_page=20&page=1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

```

--------------------------------

### Create tutorial page with Go

Source: https://tyk.io/docs/api-reference/tutorials-for-api-products/create-a-new-tutorial-page-for-this-api-product

Go example using the standard library to POST a new tutorial page to the Portal API. The payload is a JSON string and the request includes the required headers. Requires an API key and the product ID.

```go
package main

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

func main() {

	url := "http://localhost:3001/portal-api/products/{product_id}/docs"

	payload := strings.NewReader("{\n  \"Content\": \"# Title\\r\\n## Subtitle\\r\\nContent goes here\",\n  \"Status\": \"published\",\n  \"Title\": \"Get started this API Product\",\n  \"Path\": \"<string>\",\n  \"MarkdownEnabled\": true,\n  \"Lede\": \"<string>\",\n  \"Categories\": [\n    1\n  ],\n  \"Tags\": [\n    1\n  ],\n  \"MarkdownContent\": \"<string>\",\n  \"PreviewContent\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### GET /compliance/errors request example

Source: https://tyk.io/docs/api-reference/compliance/get-compliance-errors

Example request for the GET /compliance/errors endpoint. The actual request example is not available without a valid request URL.

```http
GET
/
compliance
/
errors
```

--------------------------------

### Start the Tyk stack

Source: https://tyk.io/docs/getting-started/quick-start

Starts all necessary containers and bootstraps the environment with pre-configured APIs, policies, and portal setup. May take up to 60 seconds on first run.

```bash
cd ../getting-started
bash start.sh

```

--------------------------------

### Get LLMs Count - Example

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/service-api

Example of getting the total LLM count using the direct SDK and logging it.

```go
count, err := ai_studio_sdk.GetLLMsCount(ctx)
if err != nil {
    return err
}

log.Printf("Total LLMs: %d", count)

```

--------------------------------

### file:// Deployment Example

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/overview

Local filesystem plugin deployment for development and testing. The path points to a plugin binary.

```text
file:///path/to/plugin-binary
```

--------------------------------

### Go request to get a tutorial page

Source: https://tyk.io/docs/api-reference/tutorials-for-api-products/get-a-tutorial-page

Go example using net/http to GET a tutorial page. Reads the response body and prints it.

```go
package main

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

func main() {

	url := "http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Example response for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

Example JSON response from the GET /env endpoint showing an array of environment variable strings.

```json
[
  "TYK_MDCB_ANALYTICSSTORAGE_SSLINSECURESKIPVERIFY=false",
  "TYK_MDCB_STORAGE_HOST=localhost",
  "TYK_MDCB_LISTENPORT=9090"
]

```

--------------------------------

### Ruby example to list tutorials

Source: https://tyk.io/docs/api-reference/tutorials-for-api-products/list-all-tutorials-for-this-api-product

Ruby example using net/http to GET tutorials for an API product. Replace {product_id} and <api-key> as needed. The response body is printed.

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/products/{product_id}/docs?per_page=20&page=1")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

```

--------------------------------

### Go example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

Go example using net/http to call the GET /env endpoint. Prints the response body.

```go
package main

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

func main() {

	url := "https://localhost:8181/env"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tyk-Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

```

--------------------------------

### Go example to list APIs in a product

Source: https://tyk.io/docs/api-reference/api-documentation-for-api-products/list-all-apis-included-in-this-api-product

Uses the net/http package to send a GET request with an Authorization header. Reads and prints the response body.

```go
package main

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

func main() {

	url := "http://localhost:3001/portal-api/products/{product_id}/api-details?per_page=20&page=1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Java Unirest example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

Java example using Unirest to call the GET /env endpoint. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://localhost:8181/env")
  .header("X-Tyk-Authorization", "<api-key>")
  .asString();

```

--------------------------------

### Complete Plugin Schedule Implementation

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/service-api

A full example demonstrating how to initialize a schedule during plugin startup and handle its execution via ExecuteScheduledTask.

```go
package main

import (
    "context"
    "github.com/TykTechnologies/midsommar/v2/pkg/ai_studio_sdk"
    "github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk"
)

type MyPlugin struct {
    plugin_sdk.BasePlugin
}

// Initialize creates API-managed schedules
func (p *MyPlugin) Initialize(ctx plugin_sdk.Context, config map[string]string) error {
    if ctx.Runtime != plugin_sdk.RuntimeStudio {
        return nil
    }

    apiCtx := context.Background()

    // Check if schedule exists (idempotent)
    if _, err := ai_studio_sdk.GetSchedule(apiCtx, "data-refresh"); err != nil {
        // Create new schedule
        _, err := ai_studio_sdk.CreateSchedule(
            apiCtx,
            "data-refresh",
            "Refresh External Data",
            "*/15 * * * *",  // Every 15 minutes
            "UTC",
            300,  // 5 minute timeout
            map[string]interface{}{
                "api_endpoint": "https://api.example.com/data",
            },
            true,
        )
        if err != nil {
            return fmt.Errorf("failed to create schedule: %w", err)
        }
    }

    return nil
}

// ExecuteScheduledTask handles all scheduled executions
func (p *MyPlugin) ExecuteScheduledTask(ctx plugin_sdk.Context, schedule *plugin_sdk.Schedule) error {
    switch schedule.ID {
    case "data-refresh":
        return p.refreshData(ctx, schedule)
    default:
        return fmt.Errorf("unknown schedule: %s", schedule.ID)
    }
}

func (p *MyPlugin) refreshData(ctx plugin_sdk.Context, schedule *plugin_sdk.Schedule) error {
    // Access config from schedule
    endpoint := schedule.Config["api_endpoint"].(string)

    // Perform sync logic...
    ctx.Services.Logger().Info("Refreshing data", "endpoint", endpoint)

    return nil
}
```

--------------------------------

### PHP cURL example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

PHP example using cURL to call the GET /env endpoint. Handles errors and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8181",
  CURLOPT_URL => "https://localhost:8181/env",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Tyk-Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

```

--------------------------------

### JavaScript fetch example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

JavaScript example using fetch to call the GET /env endpoint. Logs the JSON response or error.

```javascript
const options = {method: 'GET', headers: {'X-Tyk-Authorization': '<api-key>'}};

fetch('https://localhost:8181/env', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

```

--------------------------------

### Serve the Plugin (Go main function)

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/resource-types

Entry point that starts the plugin server using plugin_sdk.Serve with a new MyPlugin instance. Call this in your main function to run the plugin.

```go
func main() {
    plugin_sdk.Serve(NewMyPlugin())
}

```

--------------------------------

### List Plugins - Example

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/service-api

Example of listing plugins with pagination and iterating over the returned plugins.

```go
pluginsResp, err := ai_studio_sdk.ListPlugins(ctx, 1, 10)
if err != nil {
    return err
}

for _, plugin := range pluginsResp.Plugins {
    log.Printf("Plugin: %s - Type: %s, Active: %t",
        plugin.Name, plugin.PluginType, plugin.IsActive)
}
```

--------------------------------

### Python requests example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

Python example using the requests library to call the GET /env endpoint. Prints the response text.

```python
import requests

url = "https://localhost:8181/env"

headers = {"X-Tyk-Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

```

--------------------------------

### Go example to get example API definition

Source: https://tyk.io/docs/api-reference/apis/get-details-of-a-single-example-api-definition

Go program using net/http to GET a single example API definition. It sets the required headers and prints the response body. Replace {location} and <token> as needed.

```go
package main

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

func main() {

	url := "https://localhost:3000/api/examples/{location}?readme=false"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tyk-examples-index", "https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json")
	req.Header.Add("x-tyk-repo-url", "https://github.com/TykTechnologies/tyk-examples.git")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Show tyk bundle build help

Source: https://tyk.io/docs/api-management/plugins/overview

Displays instructions on how to create plugin bundles and the supported command options.

```bash
/opt/tyk-gateway/bin/tyk bundle build -h

```

--------------------------------

### Ruby Net::HTTP example for GET /env

Source: https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables

Ruby example using Net::HTTP to call the GET /env endpoint. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:8181/env")

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

request = Net::HTTP::Get.new(url)
request["X-Tyk-Authorization"] = '<api-key>'

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

```

--------------------------------

### Ruby example to get example API definition

Source: https://tyk.io/docs/api-reference/apis/get-details-of-a-single-example-api-definition

Ruby script using Net::HTTP to GET a single example API definition. It sets the required headers and prints the response body. Replace {location} and <token> as needed.

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:3000/api/examples/{location}?readme=false")

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

request = Net::HTTP::Get.new(url)
request["x-tyk-examples-index"] = 'https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json'
request["x-tyk-repo-url"] = 'https://github.com/TykTechnologies/tyk-examples.git'
request["Authorization"] = 'Bearer <token>'

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

--------------------------------

### Build an Example: Build echo-agent with go build

Source: https://tyk.io/docs/ai-management/ai-studio/plugins/examples

Builds the echo-agent plugin binary from the examples/plugins/studio/echo-agent directory. Run this before deploying the plugin.

```bash
cd examples/plugins/studio/echo-agent
go build -o echo-agent server/main.go

```

--------------------------------

### Readiness check with Go

Source: https://tyk.io/docs/api-reference/health/check-system-readiness-status

Go example using the `net/http` package to GET `/readiness`. It sets the `X-Tyk-Authorization` header, performs the request, and prints the response body.

```go
package main

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

func main() {

	url := "https://localhost:8181/readiness"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tyk-Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
```

--------------------------------

### Java Unirest example to get example API definition

Source: https://tyk.io/docs/api-reference/apis/get-details-of-a-single-example-api-definition

Java code using Unirest to GET a single example API definition. It sets the required headers and returns the response as a string. Replace {location} and <token> as needed.

```java
HttpResponse<String> response = Unirest.get("https://localhost:3000/api/examples/{location}?readme=false")
  .header("x-tyk-examples-index", "https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json")
  .header("x-tyk-repo-url", "https://github.com/TykTechnologies/tyk-examples.git")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### JavaScript fetch example to get example API definition

Source: https://tyk.io/docs/api-reference/apis/get-details-of-a-single-example-api-definition

JavaScript code using fetch to GET a single example API definition. It sets the required headers and logs the JSON response. Replace {location} and <token> as needed.

```javascript
const options = {
  method: 'GET',
  headers: {
    'x-tyk-examples-index': 'https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json',
    'x-tyk-repo-url': 'https://github.com/TykTechnologies/tyk-examples.git',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://localhost:3000/api/examples/{location}?readme=false', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Ruby example to list APIs in a product

Source: https://tyk.io/docs/api-reference/api-documentation-for-api-products/list-all-apis-included-in-this-api-product

Uses Net::HTTP to send a GET request with an Authorization header. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/products/{product_id}/api-details?per_page=20&page=1")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

--------------------------------

### Install Tyk Gateway

Source: https://tyk.io/docs/tyk-self-managed/install/linux

Installs the Tyk Gateway package without prompting. After installation, the service is not started automatically.

```bash
sudo apt-get install -y tyk-gateway

```

--------------------------------

### Go GET /api/examples

Source: https://tyk.io/docs/api-reference/apis/get-a-list-of-example-api-definitions

Go example using the net/http package to call the /api/examples endpoint. It sets the required headers and prints the response body.

```go
package main

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

func main() {

	url := "https://localhost:3000/api/examples"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tyk-examples-index", "https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
```
Tokens:
Raw