Unikraft Cloud Platform API

Certificates

Endpoint

Unikraft Cloud allows you to host your deployment at subdomains of the intended metro and/or use custom domains (e.g., example.com). Typically, Unikraft Cloud will automatically generate a TLS certificate for you based on Let's Encrypt™ via a DNS-01 challenge.

For subdomains, your deployment will use the wildcard TLS certificate of the respective Unikraft Cloud metro.

For wildcard domains you have to supply your own certificate. If you want to use Let's Encrypt™ you can use their DNS-based challenge and upload the resulting certificate to Unikraft Cloud.

List Certificates

GET

https://api.fra.unikraft.cloud

/v1/certificates

Get one or many certificates with their current status and configuration. It's possible to filter this list by name or UUID.

List Certificates › query Parameters

detailsboolean
Whether to include details about the certificate in the response. By default this is set to true, meaning that all information about the certificate will be included in the response. If set to false, only the basic information about the certificate will be included, such as its name and UUID.

List Certificates › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uuid
	type = object · requires: name

Properties for uuid:

uuidstring · uuid · required
Mutually exclusive with name.
Example: 123e4567-e89b-12d3-a456-426614174000

List Certificates › Responses

default

statusstring · enum · enum
The status of the response.
Enum values:
success
error
messagestring
An optional message providing additional information about the status. This field is useful when the status is not success.
Example: Failed to perform all operations
dataobject
The response data for this request.
errorsobject[]
A list of errors which may have occurred during the request.
op_time_usinteger · uint64
The operation time in microseconds. This is the time it took to process the request and generate the response.
Example: 55

Create Certificate

POST

https://api.fra.unikraft.cloud

/v1/certificates

Upload a new certificate with the given configuration.

Create Certificate › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object

Properties for name:

namestring
The name of the certificate.

This is a human-readable name that can be used to identify the certificate. The name must be unique within the context of your account. If no name is specified, a random name is generated for you. The name can also be used to identify the certificate in API calls.
Example: funky-certificate

Create Certificate › Responses

default

statusstring · enum · enum
The status of the response.
Enum values:
success
error
messagestring
An optional message providing additional information about the status. This field is useful when the status is not success.
Example: Failed to perform all operations
dataobject
The response data for this request.
errorsobject[]
A list of errors which may have occurred during the request.
op_time_usinteger · uint64
The operation time in microseconds. This is the time it took to process the request and generate the response.
Example: 32

Delete Certificates

DELETE

https://api.fra.unikraft.cloud

/v1/certificates

Delete the specified certificate(s). After this call the name of the certificate(s) are no longer valid.

Delete Certificates › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uuid
	type = object · requires: name

Properties for uuid:

uuidstring · uuid · required
Mutually exclusive with name.
Example: 123e4567-e89b-12d3-a456-426614174000

Delete Certificates › Responses

default

statusstring · enum · enum
The status of the response.
Enum values:
success
error
messagestring
An optional message providing additional information about the status. This field is useful when the status is not success.
Example: Failed to perform all operations
dataobject
The response data for this request.
errorsobject[]
A list of errors which may have occurred during the request.
op_time_usinteger · uint64
The operation time in microseconds. This is the time it took to process the request and generate the response.
Example: 42

Get Certificate by UUID

GET

https://api.fra.unikraft.cloud

/v1/certificates/{uuid}

Get a specified certificate by its UUID.

Get Certificate by UUID › path Parameters

uuidstring · uuid · required
The UUID of the certificate.

Get Certificate by UUID › Responses

default

statusstring · enum · enum
The status of the response.
Enum values:
success
error
messagestring
An optional message providing additional information about the status. This field is useful when the status is not success.
Example: Failed to perform all operations
dataobject
The response data for this request.
errorsobject[]
A list of errors which may have occurred during the request.
op_time_usinteger · uint64
The operation time in microseconds. This is the time it took to process the request and generate the response.
Example: 55

Delete Certificate by UUID

DELETE

https://api.fra.unikraft.cloud

/v1/certificates/{uuid}

Delete a specified certificate by its UUID. After this call the UUID of the certificate are no longer valid.

Delete Certificate by UUID › path Parameters

uuidstring · uuid · required
The UUID of the certificate to delete.

Delete Certificate by UUID › Responses

default

statusstring · enum · enum
The status of the response.
Enum values:
success
error
messagestring
An optional message providing additional information about the status. This field is useful when the status is not success.
Example: Failed to perform all operations
dataobject
The response data for this request.
errorsobject[]
A list of errors which may have occurred during the request.
op_time_usinteger · uint64
The operation time in microseconds. This is the time it took to process the request and generate the response.
Example: 42

Autoscale Images