VirtualApplianceSpecsResource


List virtual appliance specs


If a spec has more than one version, this request returns the default version. If there is no default version selected, it returns the last version created.

GET https://example.com/api/admin/enterprises/{enterprise}/vappspecs

Roles : [ROLE_CONSUME_VAPP_SPEC, ROLE_MANAGE_VAPP_SPEC]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
limit Integer 25 The number of entities to retrieve
by String name Order by
has String If present filter to apply in the search.
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)

Example

Delete a virtual appliance spec


Delete a virtual appliance spec and its versions.

DELETE https://example.com/api/admin/enterprises/{enterprise}/vappspecs/{spec}

Roles : [ROLE_MANAGE_VAPP_SPEC]

Example

Get a virtual appliance spec


GET https://example.com/api/admin/enterprises/{enterprise}/vappspecs/{spec}

Roles : [ROLE_CONSUME_VAPP_SPEC, ROLE_MANAGE_VAPP_SPEC]

Error Codes

  • SPEC-0 - The requested virtual appliance spec does not exist
  • SPEC-17 - Access to spec is not allowed. Enterprise is not included in spec's scope

Example

List version of a virtual appliance spec


GET https://example.com/api/admin/enterprises/{enterprise}/vappspecs/{spec}

Roles : [ROLE_CONSUME_VAPP_SPEC, ROLE_MANAGE_VAPP_SPEC]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
limit Integer 25 The number of entities to retrieve
by String name Order by
has String If present filter to apply in the search.
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)

Error Codes

  • SPEC-17 - Access to spec is not allowed. Enterprise is not included in spec's scope

Example

Update a virtual appliance spec


Update a virtual appliance Spec. You can change the name/description/icon_url/scopes

PUT https://example.com/api/admin/enterprises/{enterprise}/vappspecs/{spec}

Roles : [ROLE_MANAGE_VAPP_SPEC]

Content-Type : virtualappliancespec Accept : virtualappliancespec

Error Codes

  • LOCATION-4 - The location does not exist
  • SCOPE-1 - The requested scope does not exist
  • SPEC-11 - Cannot modify the requested spec because it belongs to another enterprise
  • SPEC-17 - Access to spec is not allowed. Enterprise is not included in spec's scope

Example