Package Exports
- @ssrfproxy/ssrfproxy-node
- @ssrfproxy/ssrfproxy-node/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ssrfproxy/ssrfproxy-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Overview
Node package for protecting your server from Server Side Request Forgery (SSRF) attacks using SSRF Proxy. Sign up for a free account to get an API key.
Install
npm i @ssrfproxy/ssrfproxy-node --save
Usage
const { SsrfProxyApi } = require('@ssrfproxy/ssrfproxy-node');
const ssrfproxy = new SsrfProxyApi({
apiKey: API_KEY_HERE,
});
const response = await ssrfproxy.proxy({
url: "https://dummyjson.com/products/1",
});
console.log(response.headers);
console.log(response.data);
Options
Option | Type | Description | Example | Required |
---|---|---|---|---|
url | string | The URL to be accessed by the API. | "http://example.com/" | Yes |
method | string | The HTTP method to be used when accessing the URL. Defaults to "GET". | "GET" | No |
headers | object | The headers to be sent when accessing the URL. | { "Content-Type": "application/json" } | No |
timeout | integer | The maximum time to wait for a response, in milliseconds. Defaults to 5000. | 5000 | No |
Advanced Usage
Under the hood ssrfproxy-node uses axios, so you can use any of the options that axios supports.