Delete a CA Certificate

Delete the specified Certificate Authority (CA) certificate using the provided ca_certificate_id.

delete

Path Parameters

ca_certificate_idstringrequired

ID of the related certificate

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

204

Successfully deleted CA Certificate or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}
 
204

Get a CA certificate

Retrieve details about the specified Certificate Authority (CA) certificate using the provided path parameter ca_certificate_id.

get

Query Parameters

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

ca_certificate_idstringrequired

The unique identifier of the certificate to retrieve.

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

The specified CA certificate exists in the system, and the response includes details about the certificate.

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

get/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}
 
application/json

Update a CA Certificate

Create or Update a CA Certificate using the provided path parameter ca_certificate_id.

put

Path Parameters

ca_certificate_idstringrequired

ID of the related certificate

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

This request body represents a new Certificate Authority (CA) certificate and includes the properties required to create a new certificate.

certstringrequired

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Response

application/json

Successfully upserted CA Certificate

CA-Certificate

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

put/runtime-groups/{runtimeGroupId}/core-entities/ca_certificates/{ca_certificate_id}

Body

{ "cert": "-----BEGIN CERTIFICATE-----..." }
 
application/json

Upstreams

Upstreams

List all Upstreams

List all registered upstreams. You can filter the results by pagination size, offset, or tags like /upstreams?size=10&offset=0.

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

A successful response listing Upstreams

dataarray[object]

The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named service.v1.xyz for a service object whose host is service.v1.xyz. Requests for this service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.

Example:{"algorithm":"round-robin","hash_fallback":"none","hash_on":"none","hash_on_cookie_path":"/","healthchecks":{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}},"threshold":0},"id":"6eed5e9c-5398-4026-9a4c-d48f18a2431e","name":"api.example.internal","slots":10000}

Show Child Parameters
offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/runtime-groups/{runtimeGroupId}/core-entities/upstreams
 
200 application/json