Skip to content

Latest commit

 

History

History
155 lines (100 loc) · 5.78 KB

File metadata and controls

155 lines (100 loc) · 5.78 KB

\ZonecryptokeyApi

All URIs are relative to http://localhost:8081/api/v1

Method HTTP request Description
CreateCryptokey Post /servers/{server_id}/zones/{zone_id}/cryptokeys Creates a Cryptokey
DeleteCryptokey Delete /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} This method deletes a key specified by cryptokey_id.
GetCryptokey Get /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} Returns all data about the CryptoKey, including the privatekey.
ListCryptokeys Get /servers/{server_id}/zones/{zone_id}/cryptokeys Get all CryptoKeys for a zone, except the privatekey
ModifyCryptokey Put /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} This method (de)activates a key from zone_name specified by cryptokey_id

CreateCryptokey

Cryptokey CreateCryptokey(ctx, serverId, zoneId, cryptokey) Creates a Cryptokey

This method adds a new key to a zone. The key can either be generated or imported by supplying the content parameter. if content, bits and algo are null, a key will be generated based on the default-ksk-algorithm and default-ksk-size settings for a KSK and the default-zsk-algorithm and default-zsk-size options for a ZSK.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
serverId string The id of the server to retrieve
zoneId string
cryptokey Cryptokey Add a Cryptokey

Return type

Cryptokey

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCryptokey

DeleteCryptokey(ctx, serverId, zoneId, cryptokeyId) This method deletes a key specified by cryptokey_id.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
serverId string The id of the server to retrieve
zoneId string The id of the zone to retrieve
cryptokeyId string The id value of the Cryptokey

Return type

(empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCryptokey

Cryptokey GetCryptokey(ctx, serverId, zoneId, cryptokeyId) Returns all data about the CryptoKey, including the privatekey.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
serverId string The id of the server to retrieve
zoneId string The id of the zone to retrieve
cryptokeyId string The id value of the CryptoKey

Return type

Cryptokey

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCryptokeys

[]Cryptokey ListCryptokeys(ctx, serverId, zoneId) Get all CryptoKeys for a zone, except the privatekey

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
serverId string The id of the server to retrieve
zoneId string The id of the zone to retrieve

Return type

[]Cryptokey

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyCryptokey

ModifyCryptokey(ctx, serverId, zoneId, cryptokeyId, cryptokey) This method (de)activates a key from zone_name specified by cryptokey_id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
serverId string The id of the server to retrieve
zoneId string
cryptokeyId string Cryptokey to manipulate
cryptokey Cryptokey the Cryptokey

Return type

(empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]