REST Resource: projects.locations.instances.keyLists

Resource: KeyList

A KeyList is a named list of blockchain addresses that transaction policies can reference, for example as a list of trusted destinations.

Each entry is a Key, a KeyRing, or a manually entered address. A KeyRing entry covers every Key in the KeyRing, including Keys created after the entry was added.

Entries are changed only with keyLists.addEntries and keyLists.removeEntries.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entries": [
    {
      object (Entry)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "uid": string
}
Fields
name

string

Identifier. The resource name of the KeyList. Format: projects/{project}/locations/{location}/instances/{instance}/keyLists/{keyList}
displayName

string

Optional. User-assigned display name for the KeyList.
description

string

Optional. User-provided description of the KeyList.
entries[]

object (Entry)

Optional. The entries in the KeyList. Can be set when the KeyList is created; after that, change them with keyLists.addEntries and keyLists.removeEntries.
createTime

string (Timestamp format)

Output only. The time at which the KeyList was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time at which the KeyList was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
uid

string

Output only. The unique server-generated identifier of the KeyList.

Entry

One entry in a KeyList.

JSON representation 
{
  "addTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "manualEntry": {
    object (ManualEntry)
  },
  "keyRing": string,
  "key": string
  // End of mutually exclusive fields.
}
Fields
addTime

string (Timestamp format)

Output only. The time at which the entry was added to the KeyList.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
What the entry refers to. Exactly one must be set. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
manualEntry

object (ManualEntry)

A manually entered address, typically one not managed by this instance.
keyRing

string

The resource name of a KeyRing in the same instance. Covers every Key in the KeyRing. Format: projects/{project}/locations/{location}/instances/{instance}/keyRings/{keyRing}
key

string

The resource name of a Key in the same instance. Format: projects/{project}/locations/{location}/instances/{instance}/keyRings/{keyRing}/keys/{key}
End of mutually exclusive fields.

ManualEntry

A manually entered blockchain address.

JSON representation 
{
  "address": string,
  "source": string,
  "reason": string
}
Fields
address

string

Required. The blockchain address, in the chain's usual text form (for example, a 0x-prefixed hex string for Ethereum). Two manual entries with the same address are the same entry.
source

string

Optional. Where the address came from, for example the name of an exchange or an internal ticket.
reason

string

Optional. Why the address is in the KeyList.

Methods

addEntries

 Adds entries to a KeyList and returns the updated KeyList.

create

 Creates a new KeyList in an instance.

delete

 Deletes a KeyList.

get

 Gets details of a single KeyList.

list

 Lists KeyLists in an instance.

removeEntries

 Removes entries from a KeyList and returns the updated KeyList.