Get API key - ProxyScrape Docs

GET

account

api-keys

{id}

Get API key

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys/{id} \
  --header 'api-token: <api-key>'

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "allowed_subaccounts": [
      "<string>"
    ],
    "allowed_ips": [
      "<string>"
    ],
    "expires_at": 123,
    "is_active": true,
    "last_used_at": 123,
    "token_preview": "<string>",
    "created_at": 123
  }
}

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

{
  "success": false,
  "error": "API key not found"
}

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

Authorizations

api-token

string

header

required

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

Path Parameters

string<uuid>

required

Response

API key metadata (no secret)

success

boolean

data

object

Show child attributes

Update API keyUpdate an API key's name, permissions, allowed_subaccounts, allowed_ips, expires_at, or is_active. The response includes an `updated_fields` array showing which fields changed. You cannot update the API key currently being used to authenticate the request — doing so returns 409. Note: sending an empty `permissions` array is silently ignored — permissions cannot be cleared via this endpoint. Permission: `account:apikeys:update`.

Get API key

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/api-keys/{id} \
  --header 'api-token: <api-key>'

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "allowed_subaccounts": [
      "<string>"
    ],
    "allowed_ips": [
      "<string>"
    ],
    "expires_at": 123,
    "is_active": true,
    "last_used_at": 123,
    "token_preview": "<string>",
    "created_at": 123
  }
}

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

{
  "success": false,
  "error": "API key not found"
}

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