Creating a plugin proxy

​

Considerations

• If there are multiple matching URL prefixes with overlapping header keys, the more specific (i.e. longer) prefix rules will be used.
• If a request from the plugin is invoked with header keys that overlap the proxy ruleset, the request-specific header values will be used.

​

Creating a plugin proxy

1. From the main sidebar, select Plugins.
2. In the upper-right corner, click Create proxy.
3. Do the following:
   • Under Proxy name, enter a human-readable name for the proxy (required).
   • Under Path, enter a unique identifier made of letters, numbers, and/or hyphens for the proxy (required).
   • In the URL prefixes section, click Add URL to configure URL prefixes to apply rules to requests going through this proxy (required). All requests passing through this proxy that match the URL prefix will have a set of rules applied.
     • Optionally, click Add header to configure a header for the URL.
       • If you are using a proxy with sensitive information, you can use mustache templating to reference a global secret by tag, e.g. {{secrets.my_auth_token}}.
4. Click Create proxy.

​

Example plugin proxy configuration

{
  "id": "22",
  "tag": "github",
  "urlConfigurations": {
    "https://api.github.com": {
      "headers": [
        { "key": "X-GitHub-API-Version", "value": "2022-11-28" },
        { "key": "Authorization", "value": "Bearer {{ secrets.github_read_token }}" }
      ]
    }
  }
}

​

Example plugin code

import { CortexApi } from "@cortexapps/plugin-core";

const getGithubReleases = async (ownerName: string, repoName: string) => {
  const githubReleases = await fetch(`https://api.github.com/repo/${ownerName}/${repoName}/releases`);
  return githubReleases.json();
};

​

Managing plugin proxies

​

Editing a plugin proxy

1. From the main sidebar, select Plugins.
2. Select the Proxies tab.
3. Locate the proxy you want to edit, then click the Overflow menu.
4. Select Edit proxy.
5. Make your changes, then click Save proxy.

​

Deleting a plugin proxy

1. From the main sidebar, select Plugins.
2. Select the Proxies tab.
3. Locate the proxy you want to delete, then click the Overflow menu.
4. Select Delete proxy. The Confirm proxy deletion window opens.
5. Click Delete.