Skip to content

cluster_resource_package

Manage cluster resource packages

Create

Path
POST /v7.0/cluster_resource_packages
Description
Create a cluster resource package
Authentication required
yes
Scope
cluster_resource_package#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource_package
ParameterTypeRequiredDetails
label
Label
 String yes

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

Length
  • Minimum length: 2 characters (inclusive).

Validation error message: length must be at least 2

Output parameters

Layout
object
Namespace
cluster_resource_package
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
environment
Environment
 Resource
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/cluster_resource_packages/{cluster_resource_package_id}
Description
Delete a cluster resource package
Authentication required
yes
Scope
cluster_resource_package#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/cluster_resource_packages
Description
List cluster resource packages
Authentication required
yes
Scope
cluster_resource_package#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource_package
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
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
cluster_resource_packages
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
environment
Environment
 Resource
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/cluster_resource_packages/{cluster_resource_package_id}
Description
Show cluster resource package
Authentication required
yes
Scope
cluster_resource_package#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
cluster_resource_package
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
environment
Environment
 Resource
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/cluster_resource_packages/{cluster_resource_package_id}
Description
Update a cluster resource package
Authentication required
yes
Scope
cluster_resource_package#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource_package
ParameterTypeRequiredDetails
label
Label
 String yes

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

Length
  • Minimum length: 2 characters (inclusive).

Validation error message: length must be at least 2

Output parameters

Layout
object
Namespace
cluster_resource_package
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
environment
Environment
 Resource
user
User
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Subresources