Skip to content

user.environment_config

User settings per environment

Index

Path
GET /v7.0/users/{user_id}/environment_configs
Description
List settings per environment
Authentication required
yes
Scope
user.environment_config#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
environment_config
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
environment
Environment
 Resource no

Output parameters

Layout
object_list
Namespace
environment_configs
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
can_create_vps
Can create a VPS
 Boolean
can_destroy_vps
Can destroy a VPS
 Boolean
vps_lifetime
Default VPS lifetime
 Integer in seconds, 0 is unlimited
max_vps_count
Maximum number of VPS per user
 Integer 0 is unlimited
default
Default
 Boolean If true, the user config is inherited from the environment config

Show

Path
GET /v7.0/users/{user_id}/environment_configs/{environment_config_id}
Description
Show settings in an environment
Authentication required
yes
Scope
user.environment_config#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
environment_config
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
can_create_vps
Can create a VPS
 Boolean
can_destroy_vps
Can destroy a VPS
 Boolean
vps_lifetime
Default VPS lifetime
 Integer in seconds, 0 is unlimited
max_vps_count
Maximum number of VPS per user
 Integer 0 is unlimited
default
Default
 Boolean If true, the user config is inherited from the environment config

Update

Path
PUT /v7.0/users/{user_id}/environment_configs/{environment_config_id}
Description
Change settings in an environment
Authentication required
yes
Scope
user.environment_config#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
environment_config
ParameterTypeRequiredDetails
can_create_vps
Can create a VPS
 Boolean no

Default: false
can_destroy_vps
Can destroy a VPS
 Boolean no

Default: false
vps_lifetime
Default VPS lifetime
 Integer no

in seconds, 0 is unlimited

Default: 0
max_vps_count
Maximum number of VPS per user
 Integer no

0 is unlimited

Default: 1
default
Default
 Boolean no

If true, the user config is inherited from the environment config

Default: true

Output parameters

Layout
object
Namespace
environment_config
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
can_create_vps
Can create a VPS
 Boolean
can_destroy_vps
Can destroy a VPS
 Boolean
vps_lifetime
Default VPS lifetime
 Integer in seconds, 0 is unlimited
max_vps_count
Maximum number of VPS per user
 Integer 0 is unlimited
default
Default
 Boolean If true, the user config is inherited from the environment config