/system/keychains/{Keychain.name}/keys/{Key.key_id}

put

https://switch-ip/rest/v10.16/system/keychains/{Keychain.name}/keys/{Key.key_id}

Path Params

Keychain.name

string

required

Reference Resource: Keychain
Name of the keychain.

Key.key_id

string

required

Reference Resource: Key
The list of all the keys for the keychain instance.

Body Params

accept_end

int64

1577836801 to 2556143999

Time since Epoch when the key will be de-activated. The accept_end should be always greater than the accept_start.

accept_start

int64

1577836800 to 2556143999

Time since Epoch from when the key will be active.

auth_key

string

length ≥ 1

Key used for authentication.

auth_type

string

enum

The type of authentication associated with this Key.

Allowed:

key_id

integer

required

Reference Resource: Key
The list of all the keys for the keychain instance.

name

string

length between 1 and 64

Name of the key.

recv_id

integer

0 to 255

Receive key id corresponding to the key instance. The keychain key cannot be used by applications until the recv id is configured.

send_end

int64

1577836801 to 2556143999

Time since Epoch when the key will be de-activated. The send_end should be always greater than the send_start.

send_id

integer

0 to 255

Send key id corresponding to the key instance. The keychain key cannot be used by applications until the send id is configured.

send_start

int64

1577836800 to 2556143999

Time since Epoch from when the key will be active.

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!