Skip to content

os_family

Manage OS families

Create

Path
POST /v7.0/os_families
Description
Authentication required
yes
Scope
os_family#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
os_family
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
description
Description
 Text no

Default: null

Output parameters

Layout
object
Namespace
os_family
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
description
Description
 Text

Delete

Path
DELETE /v7.0/os_families/{os_family_id}
Description
Authentication required
yes
Scope
os_family#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/os_families
Description
List OS families
Authentication required
yes
Scope
os_family#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
os_family
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
os_families
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
description
Description
 Text

Show

Path
GET /v7.0/os_families/{os_family_id}
Description
Authentication required
yes
Scope
os_family#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
os_family
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
description
Description
 Text

Update

Path
PUT /v7.0/os_families/{os_family_id}
Description
Authentication required
yes
Scope
os_family#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
os_family
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
description
Description
 Text no

Default: null

Output parameters

Layout
object
Namespace
os_family
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
description
Description
 Text