How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
SOAX

SOAX IP Whitelist API

Manage whitelisted IP addresses for proxy authentication

Documentation Provider Profile APIs.io OpenAPI GitHub

SOAX IP Whitelist API is one of 5 APIs that SOAX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IP Whitelist. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://partner.api.soax.com.

3 operations 3 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Server
https://partner.api.soax.com
Authentication
API Key
Contact
SOAX Support
License
Proprietary
Resource Areas
1

Authentication & Security 1

SOAX IP Whitelist API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (APIKeyHeader). By default, every request must be authenticated.

  • APIKeyHeader — Your SOAX API key from the Profile tab in your dashboard

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

IP Whitelist 3

Manage whitelisted IP addresses for proxy authentication

GET
/v1/account/package/{package_key}/ip-list
List Whitelisted IPs
listWhitelistedIps 1 param → 200401404
POST
/v1/account/package/{package_key}/update-ip
Update Whitelisted IP
updateWhitelistedIp 1 param body → 200400401
POST
/v1/account/package/{package_key}/detach-ip
Detach Whitelisted IP
detachWhitelistedIp 1 param body → 200400401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are IpOperationResponse (3 properties), IpSlot (3 properties), IpListResponse (1 property). Each schema is shown below with its type and property counts.

IpSlot
object
3 properties
DetachIpRequest
array
Array of slots or IPs to detach
UpdateIpRequest
array
Array of IP slot updates
IpOperationResponse
object
3 properties
IpListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soax-ip-whitelist-api-openapi.yml Raw ↑

Other APIs SOAX publishes across the network.

SOAX Web Data API
AE Profile APIs.io
SOAX Ecommerce Data API
AE Profile APIs.io
SOAX Geo Targeting API
AE Profile APIs.io
SOAX SERP Data API
AE Profile APIs.io
#IP Whitelist
← Back to S APIs
API Details
ID
soax:soax-ip-whitelist-api
Server
https://partner.api.soax.com
Docs
https://soax.com/web-data-api
Provider
SOAX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soax-ip-whitelist-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soax-ip-whitelist-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of SOAX IP Whitelist API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.