Skip to content

user_namespace_map.entry

Browse user namespace map entries

Create

Path
POST /v7.0/user_namespace_maps/{user_namespace_map_id}/entries
Description
Create a new map entry
Authentication required
yes
Scope
user_namespace_map.entry#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
entry
ParameterTypeRequiredDetails
kind
Kind
 String yes

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • uid
  • gid

Validation error message: %{value} cannot be used

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
vps_id
Vps_id
 Integer yes

Beginning of the ID range within VPS

Default: null

Validation rules
RuleDetails
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

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

Validation error message: must be at least 0
ns_id
Ns_id
 Integer yes

Beginning of the ID range within the user namespace

Default: null

Validation rules
RuleDetails
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

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

Validation error message: must be at least 0
count
Count
 Integer yes

Number of mapped IDs

Default: null

Validation rules
RuleDetails
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

Number
  • Must be a number after parameter type conversion.
  • Minimum: 1 (inclusive).

Validation error message: must be at least 1

Output parameters

Layout
object
Namespace
entry
ParameterTypeDescription
id
Entry ID
 Integer
kind
Kind
 String
vps_id
Vps_id
 Integer Beginning of the ID range within VPS
ns_id
Ns_id
 Integer Beginning of the ID range within the user namespace
count
Count
 Integer Number of mapped IDs

Delete

Path
DELETE /v7.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}
Description
Delete map entry
Authentication required
yes
Scope
user_namespace_map.entry#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/user_namespace_maps/{user_namespace_map_id}/entries
Description
List map entries
Authentication required
yes
Scope
user_namespace_map.entry#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
entry
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

Output parameters

Layout
object_list
Namespace
entries
ParameterTypeDescription
id
Entry ID
 Integer
kind
Kind
 String
vps_id
Vps_id
 Integer Beginning of the ID range within VPS
ns_id
Ns_id
 Integer Beginning of the ID range within the user namespace
count
Count
 Integer Number of mapped IDs

Show

Path
GET /v7.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}
Description
Authentication required
yes
Scope
user_namespace_map.entry#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
entry
ParameterTypeDescription
id
Entry ID
 Integer
kind
Kind
 String
vps_id
Vps_id
 Integer Beginning of the ID range within VPS
ns_id
Ns_id
 Integer Beginning of the ID range within the user namespace
count
Count
 Integer Number of mapped IDs

Update

Path
PUT /v7.0/user_namespace_maps/{user_namespace_map_id}/entries/{entry_id}
Description
Edit map entry
Authentication required
yes
Scope
user_namespace_map.entry#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
entry
ParameterTypeRequiredDetails
vps_id
Vps_id
 Integer no

Beginning of the ID range within VPS

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
ns_id
Ns_id
 Integer no

Beginning of the ID range within the user namespace

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
count
Count
 Integer no

Number of mapped IDs

Default: null

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

Validation error message: must be at least 1

Output parameters

Layout
object
Namespace
entry
ParameterTypeDescription
id
Entry ID
 Integer
kind
Kind
 String
vps_id
Vps_id
 Integer Beginning of the ID range within VPS
ns_id
Ns_id
 Integer Beginning of the ID range within the user namespace
count
Count
 Integer Number of mapped IDs