Proxies with an agent

The agent creates a proxy from an inbound credential, target, and target credential in one organisation and region. You need the clientId and a region before starting.

Call get_guide with guide_key: "proxy-creation" before the first create.

Create and call a proxy

1. create_target — Pass clientId, targetName, targetBaseURL, targetRegion, and optional targetTestPath. Save targets[0].sKey.
2. create_credential — Create the target credential with clientId, name, credentialType: "target", auth type, region, and its credentialSecret. Save its id.
3. create_credential — Create the inbound credential with credentialType: "proxy" in the same region. Save its id.
4. create_proxy — Pass clientId, proxyName, proxyRegion, proxyProxyCredentialId, proxyTargetId, and proxyTargetCredentialId. proxyActive defaults to true. Save proxies[0].sKey.
5. get_proxy_url — Pass proxyId and proxyRegion. Optional path appends a target path.
6. execute_proxy_read_request — Pass proxyUrl, the optional path, and the full inbound value as proxyCredentialToken.

The execution tools also include execute_proxy_create_request for POST, execute_proxy_modify_request for PUT, and execute_proxy_delete_request for DELETE. The delete tool must be confirmed before use.

Example create call

{
  "clientId": "organisation-id",
  "proxyName": "HTTPBin",
  "proxyRegion": "us-east-2",
  "proxyProxyCredentialId": "inbound-credential-id",
  "proxyTargetId": "target-id",
  "proxyTargetCredentialId": "target-credential-id",
  "proxyActive": true
}

A successful result has success: true. Use data.proxies[0].sKey as proxyId.

For existing records, use list_proxies, then get_proxy with clientId and the proxy's sKey. update_proxy changes supplied fields; setting proxyActive to false stops live traffic.

Next