Public Key.

GET

/api/secret_management/get_public_key

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/secret_management/get_public_key \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GetPublicKey API returns public part of the F5 Distributed Cloud secret management key that needs to be given to F5 Distributed Cloud secret management tool to do secret encryption.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Query Parameters

key_version

integer format: int64

The version of public key.

Responses

200

A successful response.

Media typeapplication/json

GetPublicKeyResponse

F5XC Secret Management uses asymmetric cryptography for securing secrets. Each tenant will be assigned a <public,private> keypair for secret management at registration time. While private part of the key never leaves F5 Distributed Cloud secret management, public part of this asymmetric key is used for secret encryption. Get_public_key_response is the response to the get_public_key API and holds the public key for secret encryption.

object

data

object

key_version

key_version

Version number or identifier

integer format: int64

modulus_base64

modulus_base64

Modulus as Base64 encoded string.

string

<= 1024 characters

public_exponent_base64

public_exponent_base64

Public Exponent as Base64 encoded string.

string

<= 1024 characters

tenant

tenant

Tenant of the public key.

string

>= 6 characters <= 1024 characters

Example^generated

{
  "data": {
    "key_version": 1,
    "modulus_base64": "example",
    "public_exponent_base64": "example",
    "tenant": "example"
  }
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example