user_request.registration

Request account registration

Create

Path: POST /v7.0/user_request/registrations
Description
Authentication required: no
Scope: user_request.registration#create
Aliases: new
Blocking: no

Input parameters

Layout: object
Namespace: registration

Parameter Type Required Details

login

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

yes

First and last name

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_name

Organization name

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_id

Organization ID

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `30` characters (inclusive). Validation error message: length must be at most 30

email

E-mail

String

yes

Administrator of this zone

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255
Format	Must match this regular expression: `@` `null` Validation error message: not a valid e-mail address

address

Address

Text

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

year_of_birth

Year of birth

Integer

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

how

How did you learn about us?

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

note

Notes

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

os_template

Distribution

Resource

yes

location

Location

Resource

yes

currency

Currency

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Include	Allowed values: `eur` `czk` Validation error message: %{value} cannot be used
Length	Maximum length: `10` characters (inclusive). Validation error message: length must be at most 10

language

Language

Resource

yes

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

Output parameters

Layout: object
Namespace: registration

Parameter	Type	Description
`id` Id	Integer
`user` User	Resource
`raw_user_id` Raw_user_id	Integer
`state` State	String
`api_ip_addr` API IP address	String
`api_ip_ptr` API IP PTR	String
`client_ip_addr` Client IP address	String
`client_ip_ptr` Client IP PTR	String
`admin` Admin	Resource	Filter users with administrator privileges
`admin_response` Admin's response	String
`created_at` Created at	Datetime
`updated_at` Updated at	Datetime
`label` Label	String
`login` Login	String
`full_name` Full name	String	First and last name
`org_name` Organization name	String
`org_id` Organization ID	String
`email` E-mail	String	Administrator of this zone
`address` Address	Text
`year_of_birth` Year of birth	Integer
`how` How did you learn about us?	String
`note` Notes	String
`os_template` Distribution	Resource
`location` Location	Resource
`currency` Currency	String
`language` Language	Resource
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`ip_checked` Ip_checked	Boolean
`ip_request_id` Ip_request_id	String
`ip_success` Ip_success	Boolean
`ip_message` Ip_message	String
`ip_errors` Ip_errors	String
`ip_proxy` Ip_proxy	Boolean
`ip_crawler` Ip_crawler	Boolean
`ip_recent_abuse` Ip_recent_abuse	Boolean
`ip_vpn` Ip_vpn	Boolean
`ip_tor` Ip_tor	Boolean
`ip_fraud_score` Ip_fraud_score	Integer
`mail_checked` Mail_checked	Boolean
`mail_request_id` Mail_request_id	String
`mail_success` Mail_success	Boolean
`mail_message` Mail_message	String
`mail_errors` Mail_errors	String
`mail_valid` Mail_valid	Boolean
`mail_disposable` Mail_disposable	Boolean
`mail_timed_out` Mail_timed_out	Boolean
`mail_deliverability` Mail_deliverability	String
`mail_catch_all` Mail_catch_all	Boolean
`mail_leaked` Mail_leaked	Boolean
`mail_suspect` Mail_suspect	Boolean
`mail_smtp_score` Mail_smtp_score	Integer
`mail_overall_score` Mail_overall_score	Integer
`mail_fraud_score` Mail_fraud_score	Integer
`mail_dns_valid` Mail_dns_valid	Boolean
`mail_honeypot` Mail_honeypot	Boolean
`mail_spam_trap_score` Mail_spam_trap_score	String
`mail_recent_abuse` Mail_recent_abuse	Boolean
`mail_frequent_complainer` Mail_frequent_complainer	Boolean

Index

Path: GET /v7.0/user_request/registrations
Description
Authentication required: yes
Scope: user_request.registration#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: registration

Parameter Type Required Details

from_id

From ID

Integer

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1000` (inclusive). Validation error message: must be between 0 and 1000

user

User

Resource

state

State

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `awaiting` `approved` `denied` `ignored` `pending_correction` Validation error message: %{value} cannot be used

api_ip_addr

API IP address

String

Default: null

client_ip_addr

Client IP address

String

Default: null

client_ip_ptr

Client IP PTR

String

Default: null

admin

Admin

Resource

Filter users with administrator privileges

Output parameters

Layout: object_list
Namespace: registrations

Parameter	Type	Description
`id` Id	Integer
`user` User	Resource
`raw_user_id` Raw_user_id	Integer
`state` State	String
`api_ip_addr` API IP address	String
`api_ip_ptr` API IP PTR	String
`client_ip_addr` Client IP address	String
`client_ip_ptr` Client IP PTR	String
`admin` Admin	Resource	Filter users with administrator privileges
`admin_response` Admin's response	String
`created_at` Created at	Datetime
`updated_at` Updated at	Datetime
`label` Label	String
`login` Login	String
`full_name` Full name	String	First and last name
`org_name` Organization name	String
`org_id` Organization ID	String
`email` E-mail	String	Administrator of this zone
`address` Address	Text
`year_of_birth` Year of birth	Integer
`how` How did you learn about us?	String
`note` Notes	String
`os_template` Distribution	Resource
`location` Location	Resource
`currency` Currency	String
`language` Language	Resource
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`ip_checked` Ip_checked	Boolean
`ip_request_id` Ip_request_id	String
`ip_success` Ip_success	Boolean
`ip_message` Ip_message	String
`ip_errors` Ip_errors	String
`ip_proxy` Ip_proxy	Boolean
`ip_crawler` Ip_crawler	Boolean
`ip_recent_abuse` Ip_recent_abuse	Boolean
`ip_vpn` Ip_vpn	Boolean
`ip_tor` Ip_tor	Boolean
`ip_fraud_score` Ip_fraud_score	Integer
`mail_checked` Mail_checked	Boolean
`mail_request_id` Mail_request_id	String
`mail_success` Mail_success	Boolean
`mail_message` Mail_message	String
`mail_errors` Mail_errors	String
`mail_valid` Mail_valid	Boolean
`mail_disposable` Mail_disposable	Boolean
`mail_timed_out` Mail_timed_out	Boolean
`mail_deliverability` Mail_deliverability	String
`mail_catch_all` Mail_catch_all	Boolean
`mail_leaked` Mail_leaked	Boolean
`mail_suspect` Mail_suspect	Boolean
`mail_smtp_score` Mail_smtp_score	Integer
`mail_overall_score` Mail_overall_score	Integer
`mail_fraud_score` Mail_fraud_score	Integer
`mail_dns_valid` Mail_dns_valid	Boolean
`mail_honeypot` Mail_honeypot	Boolean
`mail_spam_trap_score` Mail_spam_trap_score	String
`mail_recent_abuse` Mail_recent_abuse	Boolean
`mail_frequent_complainer` Mail_frequent_complainer	Boolean

Preview

Path: GET /v7.0/user_request/registrations/{registration_id}/{token}
Description
Authentication required: no
Scope: user_request.registration#preview
Aliases
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: registration

Parameter	Type	Description
`id` Id	Integer
`admin_response` Admin's response	String
`login` Login	String
`full_name` Full name	String	First and last name
`org_name` Organization name	String
`org_id` Organization ID	String
`email` E-mail	String	Administrator of this zone
`address` Address	Text
`year_of_birth` Year of birth	Integer
`how` How did you learn about us?	String
`note` Notes	String
`os_template` Distribution	Resource
`location` Location	Resource
`currency` Currency	String
`language` Language	Resource
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague

Resolve

Path: POST /v7.0/user_request/registrations/{registration_id}/resolve
Description: Resolve user request
Authentication required: yes
Scope: user_request.registration#resolve
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: registration

Parameter Type Required Details

action

Action

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Include	Allowed values: `approve` `deny` `ignore` `request_correction` Validation error message: %{value} cannot be used

reason

Reason

Text

Default: null

login

String

Default: null

Validation rules
Rule	Details
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

First and last name

Default: null

Validation rules
Rule	Details
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_name

Organization name

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_id

Organization ID

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `30` characters (inclusive). Validation error message: length must be at most 30

email

E-mail

String

Administrator of this zone

Default: null

Validation rules
Rule	Details
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255
Format	Must match this regular expression: `@` `null` Validation error message: not a valid e-mail address

address

Address

Text

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

year_of_birth

Year of birth

Integer

Default: null

how

How did you learn about us?

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

note

Notes

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

os_template

Distribution

Resource

location

Location

Resource

currency

Currency

String

Default: null

Validation rules
Rule	Details
Include	Allowed values: `eur` `czk` Validation error message: %{value} cannot be used
Length	Maximum length: `10` characters (inclusive). Validation error message: length must be at most 10

language

Language

Resource

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

activate

Activate account

Boolean

Default: true

node

Node

Resource

Create the new VPS on this node

create_vps

Create VPS

Boolean

Default: true

Output parameters

No parameters.

Show

Path: GET /v7.0/user_request/registrations/{registration_id}
Description
Authentication required: yes
Scope: user_request.registration#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: registration

Parameter	Type	Description
`id` Id	Integer
`user` User	Resource
`raw_user_id` Raw_user_id	Integer
`state` State	String
`api_ip_addr` API IP address	String
`api_ip_ptr` API IP PTR	String
`client_ip_addr` Client IP address	String
`client_ip_ptr` Client IP PTR	String
`admin` Admin	Resource	Filter users with administrator privileges
`admin_response` Admin's response	String
`created_at` Created at	Datetime
`updated_at` Updated at	Datetime
`label` Label	String
`login` Login	String
`full_name` Full name	String	First and last name
`org_name` Organization name	String
`org_id` Organization ID	String
`email` E-mail	String	Administrator of this zone
`address` Address	Text
`year_of_birth` Year of birth	Integer
`how` How did you learn about us?	String
`note` Notes	String
`os_template` Distribution	Resource
`location` Location	Resource
`currency` Currency	String
`language` Language	Resource
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague
`ip_checked` Ip_checked	Boolean
`ip_request_id` Ip_request_id	String
`ip_success` Ip_success	Boolean
`ip_message` Ip_message	String
`ip_errors` Ip_errors	String
`ip_proxy` Ip_proxy	Boolean
`ip_crawler` Ip_crawler	Boolean
`ip_recent_abuse` Ip_recent_abuse	Boolean
`ip_vpn` Ip_vpn	Boolean
`ip_tor` Ip_tor	Boolean
`ip_fraud_score` Ip_fraud_score	Integer
`mail_checked` Mail_checked	Boolean
`mail_request_id` Mail_request_id	String
`mail_success` Mail_success	Boolean
`mail_message` Mail_message	String
`mail_errors` Mail_errors	String
`mail_valid` Mail_valid	Boolean
`mail_disposable` Mail_disposable	Boolean
`mail_timed_out` Mail_timed_out	Boolean
`mail_deliverability` Mail_deliverability	String
`mail_catch_all` Mail_catch_all	Boolean
`mail_leaked` Mail_leaked	Boolean
`mail_suspect` Mail_suspect	Boolean
`mail_smtp_score` Mail_smtp_score	Integer
`mail_overall_score` Mail_overall_score	Integer
`mail_fraud_score` Mail_fraud_score	Integer
`mail_dns_valid` Mail_dns_valid	Boolean
`mail_honeypot` Mail_honeypot	Boolean
`mail_spam_trap_score` Mail_spam_trap_score	String
`mail_recent_abuse` Mail_recent_abuse	Boolean
`mail_frequent_complainer` Mail_frequent_complainer	Boolean

Update

Path: PUT /v7.0/user_request/registrations/{registration_id}/{token}
Description
Authentication required: no
Scope: user_request.registration#update
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: registration

Parameter Type Required Details

login

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Format	Must match this regular expression: `\A[a-zA-Z0-9.-]{2,63}\z` `null` Validation error message: not a valid login

full_name

Full name

String

yes

First and last name

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_name

Organization name

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255

org_id

Organization ID

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `30` characters (inclusive). Validation error message: length must be at most 30

email

E-mail

String

yes

Administrator of this zone

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `255` characters (inclusive). Validation error message: length must be at most 255
Format	Must match this regular expression: `@` `null` Validation error message: not a valid e-mail address

address

Address

Text

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

year_of_birth

Year of birth

Integer

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty

how

How did you learn about us?

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

note

Notes

String

Default: null

Validation rules
Rule	Details
Length	Maximum length: `500` characters (inclusive). Validation error message: length must be at most 500

os_template

Distribution

Resource

yes

location

Location

Resource

yes

currency

Currency

String

yes

Default: null

Validation rules
Rule	Details
Present	Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character. Validation error message: must be present and non-empty
Include	Allowed values: `eur` `czk` Validation error message: %{value} cannot be used
Length	Maximum length: `10` characters (inclusive). Validation error message: length must be at most 10

language

Language

Resource

yes

time_zone

Time zone

String

IANA time zone identifier, e.g. Europe/Prague

Default: null

Output parameters

Layout: object
Namespace: registration

Parameter	Type	Description
`id` Id	Integer
`login` Login	String
`full_name` Full name	String	First and last name
`org_name` Organization name	String
`org_id` Organization ID	String
`email` E-mail	String	Administrator of this zone
`address` Address	Text
`year_of_birth` Year of birth	Integer
`how` How did you learn about us?	String
`note` Notes	String
`os_template` Distribution	Resource
`location` Location	Resource
`currency` Currency	String
`language` Language	Resource
`time_zone` Time zone	String	IANA time zone identifier, e.g. Europe/Prague

user_request.registration#

Create#

Input parameters#

Output parameters#

Index#

Input parameters#

Output parameters#

Preview#

Input parameters#

Output parameters#

Resolve#

Input parameters#

Output parameters#

Show#

Input parameters#

Output parameters#

Update#

Input parameters#

Output parameters#

user_request.registration

Create

Input parameters

Output parameters

Index

Input parameters

Output parameters

Preview

Input parameters

Output parameters

Resolve

Input parameters

Output parameters

Show

Input parameters

Output parameters

Update

Input parameters

Output parameters