component

Browse vpsAdmin components

Index

Path: GET /v7.0/components
Description: List vpsAdmin components
Authentication required: no
Scope: component#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: component

Parameter Type Required Details

from_id

From ID

Integer

no

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

no

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

Output parameters

Layout: object_list
Namespace: components

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`label` Label	String
`description` Description	Text

Show

Path: GET /v7.0/components/{component_id}
Description: Show vpsAdmin component
Authentication required: no
Scope: component#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: component

Parameter	Type	Description
`id` Id	Integer
`name` Name	String
`label` Label	String
`description` Description	Text