Create API key - ProxyScrape Docs

POST

account

api-keys

Create API key

curl --request POST \
  --url https://api.proxyscrape.com/v4/account/api-keys \
  --header 'Content-Type: application/json' \
  --header 'api-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ]
}
'

import requests

url = "https://api.proxyscrape.com/v4/account/api-keys"

payload = {
    "name": "<string>",
    "permissions": ["<string>"]
}
headers = {
    "api-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', permissions: ['<string>']})
};

fetch('https://api.proxyscrape.com/v4/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "API key created successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "token": "<string>",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "allowed_subaccounts": [
      "<string>"
    ],
    "allowed_ips": [
      "<string>"
    ],
    "expires_at": 123,
    "created_at": 123
  },
  "warning": "This token will only be shown once. Please copy it now."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "<string>",
  "invalid_permissions": [
    "<string>"
  ],
  "excess_permissions": [
    "<string>"
  ]
}

{
  "success": false,
  "error": "<string>",
  "messages": {},
  "invalid_permissions": [
    "<string>"
  ],
  "invalid_subaccounts": [
    "<string>"
  ],
  "invalid_ips": [
    "<string>"
  ]
}

{
  "success": false,
  "error": "Failed to create API key"
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Body

application/json

name

string

required

Human-readable label for the key.

Maximum string length: 100

permissions

string[]

required

List of permission strings. Use GET /v4/account/api-keys/allowed-permissions to see what your account can grant.

Minimum array length: 1

allowed_subaccounts

string[]

Subaccount UUIDs this key can act on. Empty array means all subaccounts.

allowed_ips

string[]

IP addresses or CIDR ranges allowed to use this key. Empty array means no IP restriction.

expires_at

integer | null

Unix timestamp for key expiry. Must be in the future. Omit or null for no expiry.

Response

Created API key. The data.token field contains the 64-character secret — store it securely, it is only shown once.

success

boolean

message

string

Example:

"API key created successfully"

data

object

Show child attributes

warning

string

Example:

"This token will only be shown once. Please copy it now."

Get API keyGet a single API key by its UUID. Returns metadata only — the secret is never returned after creation. Permission: `account:apikeys:read`.

Create API key

curl --request POST \
  --url https://api.proxyscrape.com/v4/account/api-keys \
  --header 'Content-Type: application/json' \
  --header 'api-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ]
}
'

import requests

url = "https://api.proxyscrape.com/v4/account/api-keys"

payload = {
    "name": "<string>",
    "permissions": ["<string>"]
}
headers = {
    "api-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', permissions: ['<string>']})
};

fetch('https://api.proxyscrape.com/v4/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "API key created successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "token": "<string>",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "allowed_subaccounts": [
      "<string>"
    ],
    "allowed_ips": [
      "<string>"
    ],
    "expires_at": 123,
    "created_at": 123
  },
  "warning": "This token will only be shown once. Please copy it now."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "<string>",
  "invalid_permissions": [
    "<string>"
  ],
  "excess_permissions": [
    "<string>"
  ]
}

{
  "success": false,
  "error": "<string>",
  "messages": {},
  "invalid_permissions": [
    "<string>"
  ],
  "invalid_subaccounts": [
    "<string>"
  ],
  "invalid_ips": [
    "<string>"
  ]
}

{
  "success": false,
  "error": "Failed to create API key"
}