Skip to main content
A credential is the username and password you use to connect to the Residential, Datacenter, or Mobile network. Your API key selects the workspace, so you never send an organization ID.

List credentials

The list includes each credential’s product, status, funding source, traffic used, and limits. It never includes passwords.

Create a credential

This creates a live credential. Traffic sent through it uses your GB package or organization balance.
  • name is required and can be up to 24 characters.
  • proxy_type is residential (default), datacenter, or mobile.
  • You need a GB package for that product or a positive balance. Otherwise the request returns 402 insufficient_balance.
The 201 response includes the username, password, and gateway details. Store the password as a secret.

Read a password

Use the base username. Add country, city, and session parameters only when you connect. See connection formats.

Limit traffic

Cap what a credential can use. This is useful when you give a credential to a teammate, a customer, or an AI agent. Limits are in MB, and 0 removes a limit. Daily, weekly, and monthly periods reset in UTC.
This changes a live credential. Requests stop when a limit is reached.
Fields you omit keep their current value. GET on the same path returns the limits, the consumption in each period, and reset times.

Delete a credential

Deletion is permanent. Connections that use the credential stop working immediately.
A successful deletion returns 204. Static ISP subscriptions are not managed here; use the Static ISP endpoints.