swagger: "2.0" info: description: "" version: "1.0.2" title: "Partner API" termsOfService: "" contact: email: "support@soax.com" license: name: "Apache 2.0" url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "partner.api.soax.com" basePath: "/v1/account" tags: - name: "ip" description: "Ip whitelist management" - name: "proxy" description: "Proxy management" schemes: - "https" paths: /package/{package}/ip-list: get: tags: - "ip" summary: "Get a list of IP addresses by slot " description: "" operationId: "" produces: - "application/json" parameters: - in: header name: api-key type: string description: "Required. Partne API key" required: true - in: path name: package type: string description: "Required. Package key" required: true responses: "200": description: "List requested successfully" schema: type: array items: $ref: "#/definitions/ip" "400": description: "Bad request" "403": description: "Empty or wrong api_key header or wrong package key" "429": description: "Too many requests per second" "500": description: "Internal server error" /package/{package}/update-ip: post: tags: - "ip" summary: "Update ip address by slot index" description: "" operationId: "" produces: - "application/json" parameters: - in: header name: api-key type: string description: "Required. Partner API key" required: true - in: path name: package type: string description: "Required. Package key" required: true - in: body name: request schema: type: array items: $ref: "#/definitions/ip" responses: "200": description: "IP updated" "400": description: "Bad request" "403": description: "Empty or wrong api_key header or wrong package key" "429": description: "Too many requests per second" "500": description: "Internal server error" /package/{package}/detach-ip: post: tags: - "ip" summary: "Detach ip by slot index or by address" description: "" operationId: "" produces: - "application/json" parameters: - in: header name: api-key type: string description: "Required. Partner API key" required: true - in: path name: package type: string description: "Required. Package key" required: true - in: body name: request schema: type: array items: type: object properties: ip: type: string slot: type: integer responses: "200": description: "IP detached" "400": description: "Bad request" "403": description: "Empty or wrong api_key header or wrong package key" "429": description: "Too many requests per second" "500": description: "Internal server error" /package/{package}/proxy-export: post: tags: - "proxy" produces: - "text/html" parameters: - in: header name: api-key type: string description: "Required. Partner API key" required: true - in: path name: package type: string description: "Required. Package key" required: true - in: body name: request schema: $ref: "#/definitions/proxy-export" responses: "200": description: "Proxe exported successfully" "400": description: "Bad request" "403": description: "Empty or wrong api_key header or wrong package key" "429": description: "Too many requests per second" "500": description: "Internal server error" definitions: ip: type: object properties: ip: type: string slot: type: integer comment: type: string proxy-export: type: object properties: authorization: type: string enum: [lp, ip] description: "Authorization type" template: type: string description: "Output template. Valid variables: {login},{pass},{domain},{port}. Ex.: {login}:{pass}@{domain}:{port}" default: "" server: type: string enum: [domain, ip] description: "Output server" filters: type: array items: type: object properties: iso: type: string description: "Country" default: "" isp: type: string description: "ISP" default: "" connection: type: string description: "Connection" enum: [wifi] ports: type: integer description: "Ports" default: 1