Certificate
objectA certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order: main certificate on the top, followed by any intermediates.
PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.
PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.
PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
A string representing a wildcard host name, such as *.example.com.
A string representing a tag.
Unix epoch when the resource was last updated.
Consumer
objectThe Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.
Unix epoch when the resource was created.
Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
A string representing a tag.
Unix epoch when the resource was last updated.
The unique username of the Consumer. You must send either this field or custom_id with the request.
ConsumerGroup
objectUnix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
ConsumerGroupInsideWrapper
objectShow Child Parameters
CustomPlugin
objectUnix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
The handler for the given custom plugin.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given custom plugin.
The schema for the given custom plugin.
A string representing a tag.
Unix epoch when the resource was last updated.