JavaScript
import GboxSDK from "gbox-sdk";
const gboxSDK = new GboxSDK({
apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});
async function main() {
const box = await gboxSDK.create({ type: "android" });
const proxySettings = await box.proxy.get();
console.log("Proxy settings:", proxySettings);
}
main();import os
from gbox_sdk import GboxSDK
def main():
gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"]) # This is the default and can be omitted
# Create Android box
box = gbox_sdk.create(type="android")
# Get proxy settings
proxy_settings = box.proxy.get()
print("Proxy settings:", proxy_settings)
if __name__ == "__main__":
main()curl --request GET \
--url https://gbox.ai/api/v1/boxes/{boxId}/proxy \
--header 'Authorization: Bearer <token>'{
"host": "127.0.0.1",
"port": 8080,
"auth": {
"username": "admin",
"password": "password"
},
"excludes": [
"127.0.0.1",
"localhost"
],
"pacUrl": "http://proxy.company.com/proxy.pac"
}Box
Get proxy
Retrieves the HTTP proxy settings for a specific box. Use this endpoint to route traffic through the box’s network.
GET
/
boxes
/
{boxId}
/
proxy
JavaScript
import GboxSDK from "gbox-sdk";
const gboxSDK = new GboxSDK({
apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});
async function main() {
const box = await gboxSDK.create({ type: "android" });
const proxySettings = await box.proxy.get();
console.log("Proxy settings:", proxySettings);
}
main();import os
from gbox_sdk import GboxSDK
def main():
gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"]) # This is the default and can be omitted
# Create Android box
box = gbox_sdk.create(type="android")
# Get proxy settings
proxy_settings = box.proxy.get()
print("Proxy settings:", proxy_settings)
if __name__ == "__main__":
main()curl --request GET \
--url https://gbox.ai/api/v1/boxes/{boxId}/proxy \
--header 'Authorization: Bearer <token>'{
"host": "127.0.0.1",
"port": 8080,
"auth": {
"username": "admin",
"password": "password"
},
"excludes": [
"127.0.0.1",
"localhost"
],
"pacUrl": "http://proxy.company.com/proxy.pac"
}Authorizations
Enter your API Key in the format: Bearer . Get it from https://gbox.ai
Path Parameters
Box ID
Example:
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
Response
200 - application/json
Proxy
Box Http Proxy
The host address of the proxy server
Example:
"127.0.0.1"
The port number of the proxy server
Example:
8080
Authentication for the proxy
Show child attributes
Show child attributes
List of IP addresses and domains that should bypass the proxy. These addresses will be accessed directly without going through the proxy server. Default is ['127.0.0.1', 'localhost']
Example:
["127.0.0.1", "localhost"]
PAC (Proxy Auto-Configuration) URL.
Example:
"http://proxy.company.com/proxy.pac"
Was this page helpful?