Smartproxy

opencollection: 1.0.0
info:
  name: Smartproxy API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Authenticate
      type: http
    http:
      method: POST
      url: https://api.decodo.com/v1/auth
      body:
        type: json
        data: '{}'
    docs: Authenticates with the Smartproxy API and returns a user ID and token required for subsequent API calls.
- info:
    name: Sub-Users
    type: folder
  items:
  - info:
      name: Get Sub-Users
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/users/:userId/sub-users
      params:
      - name: userId
        value: ''
        type: path
        description: Primary account user ID
    docs: Retrieves all proxy sub-user accounts for the specified user.
  - info:
      name: Create Sub-User
      type: http
    http:
      method: POST
      url: https://api.decodo.com/v1/users/:userId/sub-users
      params:
      - name: userId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Creates a new proxy sub-user account for residential or datacenter proxy services.
  - info:
      name: Update Sub-User
      type: http
    http:
      method: PUT
      url: https://api.decodo.com/v1/users/:userId/sub-users
      params:
      - name: userId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Updates a sub-user account's traffic limits or password.
  - info:
      name: Delete Sub-User
      type: http
    http:
      method: DELETE
      url: https://api.decodo.com/v1/users/:userId/sub-users/:subUserId
      params:
      - name: userId
        value: ''
        type: path
      - name: subUserId
        value: ''
        type: path
    docs: Permanently removes a proxy sub-user account.
- info:
    name: Traffic
    type: folder
  items:
  - info:
      name: Get Sub-User Traffic
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/users/:userId/sub-users/:username/traffic
      params:
      - name: userId
        value: ''
        type: path
      - name: username
        value: ''
        type: path
        description: Sub-user username
    docs: Retrieves traffic usage metrics for a specific sub-user.
  - info:
      name: Get Allocated Traffic
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/users/:userId/allocated-traffic
      params:
      - name: userId
        value: ''
        type: path
    docs: Retrieves the total allocated traffic across all sub-users for the residential subscription.
- info:
    name: Whitelisted IPs
    type: folder
  items:
  - info:
      name: Get Whitelisted IPs
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/users/:userId/whitelisted-ips
      params:
      - name: userId
        value: ''
        type: path
    docs: Lists all IP addresses whitelisted for proxy authentication without credentials.
  - info:
      name: Add Whitelisted IPs
      type: http
    http:
      method: POST
      url: https://api.decodo.com/v1/users/:userId/whitelisted-ips
      params:
      - name: userId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Adds one or more IP addresses to the proxy authentication whitelist.
  - info:
      name: Delete Whitelisted IP
      type: http
    http:
      method: DELETE
      url: https://api.decodo.com/v1/users/:userId/whitelisted-ips/:id
      params:
      - name: userId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
        description: Whitelisted IP record ID
    docs: Removes an IP address from the proxy authentication whitelist.
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: Get Subscriptions
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/users/:userId/subscriptions
      params:
      - name: userId
        value: ''
        type: path
    docs: Retrieves the user's active subscription details including plan limits and validity dates.
- info:
    name: Endpoints
    type: folder
  items:
  - info:
      name: Get Endpoints
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/endpoints
    docs: Lists all available proxy endpoints with their connection details.
  - info:
      name: Get Endpoints By Type
      type: http
    http:
      method: GET
      url: https://api.decodo.com/v1/endpoints/:type
      params:
      - name: type
        value: ''
        type: path
        description: Proxy endpoint type
    docs: Retrieves proxy endpoints filtered by connection type. Types include random (rotating) and sticky (session-persistent)
      proxies.
bundled: true