API For Share Code

List share code

get

Returns a list of share codes

Authorizations

api_key

api-keystringRequired

Query parameters

statusintegerOptional

Filter by share code status.

limitintegerOptional

Maximum number of items to return. Default: 30.

pageintegerOptional

Page data request. Default: 1

sort_bystringOptional

Field to sort by. Options: code, amount_ips, created_at. Default: created_at.

order_bystringOptional

Sort order: asc or desc. Default: desc.

keywordstringOptional

Search by keyword in the code field.

emailstringOptional

Filter share codes forwarded to a specific email. Example: [email protected].

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication error

application/json

get

/client/v1/cd-keys/list-share-code

HTTPcURLJavaScriptPython

GET /client/v1/cd-keys/list-share-code HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*

{
  "success": true,
  "message": "text",
  "result": {
    "items": [
      {
        "code": "text",
        "forward_to": null,
        "used_by": null,
        "number_of_ips": 1,
        "status": 1,
        "used_at": null,
        "created_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1
  }
}

List of use codes

get

Returns a list of use codes

Authorizations

api_key

api-keystringRequired

Query parameters

statusintegerOptional

Filter by code status.

limitintegerOptional

Maximum number of items to return. Default: 30.

pageintegerOptional

Page data request. Default: 1

sort_bystringOptional

Field to sort by. Options: code, amount_ips, used_at. Default: used_at.

order_bystringOptional

Sort order. Options: asc, desc. Default: desc.

keywordstringOptional

Search by keyword in the code field.

emailstringOptional

Filter codes received by a specific email. Example: [email protected].

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication error

application/json

get

/client/v1/cd-keys/list-use-code

HTTPcURLJavaScriptPython

GET /client/v1/cd-keys/list-use-code HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*

{
  "success": true,
  "message": "text",
  "result": {
    "items": [
      {
        "code": "text",
        "forward_to": null,
        "used_by": null,
        "number_of_ips": 1,
        "status": 1,
        "used_at": null,
        "created_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1
  }
}

Generate Share Code

post

Generates one or more share codes for distributing IPs.

Authorizations

api_key

api-keystringRequired

Body

application/json

planintegerRequired

Plan of data share. Currently only 1 = IP plan.

Example: 1

number_of_ipsintegerRequired

Number of IPs to allocate per code.

Example: 10

number_of_codesintegerRequired

Number of share codes to generate.

Example: 5

forward_tostringOptional

Email address of the recipient to forward the code to. Example: [email protected].

Example: [email protected]

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication error

application/json

post

/client/v1/cd-keys/generate

HTTPcURLJavaScriptPython

POST /client/v1/cd-keys/generate HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "plan": 1,
  "number_of_ips": 10,
  "number_of_codes": 5,
  "forward_to": "[email protected]"
}

{
  "success": true,
  "message": "text",
  "result": [
    {
      "id": 1,
      "account_id": 1,
      "plan": 1,
      "amount_ips": 1,
      "code": "text",
      "forward_to": null,
      "created_at": 1
    }
  ]
}

Use code

post

Consumes one or more share codes to redeem IPs.

Authorizations

api_key

api-keystringRequired

Body

application/json

codesstring[]Required

Array of share codes to redeem.

Example: ["code_1","code_2","code_3"]

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication error

application/json

post

/client/v1/cd-keys/use-code

HTTPcURLJavaScriptPython

POST /client/v1/cd-keys/use-code HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "codes": [
    "code_1",
    "code_2",
    "code_3"
  ]
}

{
  "success": true,
  "message": "text",
  "result": {
    "used_codes": [
      "text"
    ]
  }
}

Revoke share code

delete

Revokes one or more previously issued share codes.

Authorizations

api_key

api-keystringRequired

Body

application/json

codesstring[]Required

Array of share codes to revoke.

Example: ["code_1","code_2","code_3"]

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication error

application/json

delete

/client/v1/cd-keys/revoke-code

HTTPcURLJavaScriptPython

DELETE /client/v1/cd-keys/revoke-code HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "codes": [
    "code_1",
    "code_2",
    "code_3"
  ]
}

{
  "success": true,
  "message": "text",
  "result": {}
}