Skip to content

vps_user_data

Manage VPS user data

Create

Path
POST /v7.0/vps_user_data
Description
Store VPS user data
Authentication required
yes
Scope
vps_user_data#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
vps_user_data
ParameterTypeRequiredDetails
user
User
 Resource no
label
Label
 String no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
format
Format
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • script
  • cloudinit_config
  • cloudinit_script
  • nixos_configuration
  • nixos_flake_configuration
  • nixos_flake_uri

Validation error message: %{value} cannot be used
content
Content
 Text no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 65536 characters (inclusive).

Validation error message: length must be at most 65536

Output parameters

Layout
object
Namespace
vps_user_data
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
format
Format
 String
content
Content
 Text
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Delete

Path
DELETE /v7.0/vps_user_data/{vps_user_data_id}
Description
Delete VPS user data
Authentication required
yes
Scope
vps_user_data#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Deploy

Path
POST /v7.0/vps_user_data/{vps_user_data_id}/deploy
Description
Deploy user data to VPS
Authentication required
yes
Scope
vps_user_data#deploy
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
vps_user_data
ParameterTypeRequiredDetails
vps
VPS
 Resource yes

Output parameters

No parameters.

Index

Path
GET /v7.0/vps_user_data
Description
List VPS user data
Authentication required
yes
Scope
vps_user_data#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
vps_user_data
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
user
User
 Resource no
format
Format
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • script
  • cloudinit_config
  • cloudinit_script
  • nixos_configuration
  • nixos_flake_configuration
  • nixos_flake_uri

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
vps_user_data
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
format
Format
 String
content
Content
 Text
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Show

Path
GET /v7.0/vps_user_data/{vps_user_data_id}
Description
Show VPS user data
Authentication required
yes
Scope
vps_user_data#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
vps_user_data
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
format
Format
 String
content
Content
 Text
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime

Update

Path
PUT /v7.0/vps_user_data/{vps_user_data_id}
Description
Update VPS user data
Authentication required
yes
Scope
vps_user_data#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
vps_user_data
ParameterTypeRequiredDetails
label
Label
 String no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
format
Format
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • script
  • cloudinit_config
  • cloudinit_script
  • nixos_configuration
  • nixos_flake_configuration
  • nixos_flake_uri

Validation error message: %{value} cannot be used
content
Content
 Text no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 65536 characters (inclusive).

Validation error message: length must be at most 65536

Output parameters

Layout
object
Namespace
vps_user_data
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
format
Format
 String
content
Content
 Text
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime