EventGatewayModifyVault

The typed schema of the vault to modify it.

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters
Example

EventGatewayModifyVaultSecret

The typed schema of the vault secret to modify it.

keystringrequired

The key of the vault secret.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

valuestringrequired

The value of the vault secret.

>= 1 characters<= 65535 characters

Example

CursorMetaPage

object
firststring(path)

URI to the first page

laststring(path)

URI to the last page

nextstring(path)required

URI to the next page

previousstring(path)required

URI to the previous page

sizenumberrequired

Requested page size

Example:10

Example

CursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example