Skip to main content
POST
Create proxy profile

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json
name
string
required

Name of the proxy profile

Required string length: 1 - 60
origin_host
string
required

Origin host (IPv4 address or FQDN) for the proxy profile.

rules
PolicyRules · object[]
required

Rules grouped by policy

Minimum array length: 1
template_id
integer
required

ID of the proxy template to render this profile with

protected_ip_address
string<ipv4> | null

Optional manual IPv4 selection from any assigned non-common pool, including shared pools. Omit or use null for automatic allocation. Creation rechecks availability; no fallback on manual failure.

Example:

"192.0.2.10"

Response

Successful Response

id
integer
required

Unique identifier of the proxy profile

client_id
integer
required

Identifier of the client owning this profile

name
string
required

Name of the proxy profile

origin_host
string
required

Origin host (IPv4 address or FQDN) of the proxy profile

protected_ip_address
string<ipv4> | null
required

Protected IP address assigned to the profile

status
enum<string>
required

Current status of the proxy profile

Available options:
INACTIVE,
ACTIVE,
DELETED
mode
enum<string>
required

Operating mode, set by the template: 'regular' proxies traffic through the edge proxy; 'shield' also routes it through the template's shield sites

Available options:
regular,
shield
is_processing
boolean
required

Whether the profile is currently being processed

is_error
boolean
required

Whether the profile is in an error state

error_details
ErrorDescription · object | null
required

Details of the error if the profile is in an error state

created_at
string<date-time>
required

Timestamp when the profile was created

template_id
integer
required

ID of the proxy template bound to this profile

rules
PolicyRules · object[]
required
read-only