reference_service_keys

Creates, updates, deletes, gets or lists a reference_service_keys resource.

Overview

Name	reference_service_keys
Type	Resource
Id	ovh.okms.reference_service_keys

Fields

The following fields are returned by SELECT queries:

list

Service key type, size, curve, operations and protectionLevel combination

Name	Datatype	Description
curves	array	Allowed service key curves for type
default	boolean	Is default service key type?
operations	array	Allowed service key operations for type
protection_level	array	Allowed protection level for type (wire: protectionLevel)
sizes	array	Allowed service key sizes for type
type	string	Service key type (EC, RSA, oct)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	region	x_pagination_cursor, x_pagination_size	Returns the valid combinations of key type, size, curve, operations and protection level for a region. Use it before creating or importing a service key.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
region	string	OKMS Region
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the valid combinations of key type, size, curve, operations and protection level for a region. Use it before creating or importing a service key.

SELECT
curves,
default,
operations,
protection_level,
sizes,
type
FROM ovh.okms.reference_service_keys
WHERE region = '{{ region }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;