AI Gateway DataPlane Certificates

API related to the management of AI Gateway DataPlane Certificates.

List AI Gateway DataPlane Certificates

Returns a list of DataPlane certificates that are associated to this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

Example response

* Additional properties are NOT allowed.
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/ai-gateways/{gatewayId}/data-plane-certificates
 
application/json

Create New AI Gateway DataPlane Certificate

Create a new DataPlane Certificate for this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.

post

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Body

application/json

CreateAIGatewayDataPlaneCertificateRequest

* Additional properties are NOT allowed.
certstringrequired

JSON escaped string of the certificate.

titlestringrequired

A human-readable name for the certificate.

descriptionstring

An optional description of the certificate.

Response

application/json

Response body for creating a DataPlane certificate.

AIGatewayDataPlaneClientCertificate

* Additional properties are NOT allowed.
certstringrequired

JSON escaped string of the certificate.

titlestringrequired

A human-readable name for the certificate.

descriptionstring

An optional description of the certificate.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

post/ai-gateways/{gatewayId}/data-plane-certificates

Body

{ "title": "My AI Gateway Data Plane Certificate", "description": "My description", "cert": "-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n" }
 
application/json

Get a DataPlane Certificate

Retrieve a DataPlane certificate associated to this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

certificateIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

Response body for retrieving a DataPlane certificate.

AIGatewayDataPlaneClientCertificate

* Additional properties are NOT allowed.
certstringrequired

JSON escaped string of the certificate.

titlestringrequired

A human-readable name for the certificate.

descriptionstring

An optional description of the certificate.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

get/ai-gateways/{gatewayId}/data-plane-certificates/{certificateId}
 
application/json

Delete AI Gateway DataPlane Certificate

Remove a DataPlane client certificate associated to this AI Gateway. Removing a DataPlane certificate would invalidate any DataPlanes currently connected to this AI Gateway using this certificate.

delete

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

certificateIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

No Content

delete/ai-gateways/{gatewayId}/data-plane-certificates/{certificateId}