Python SDK

Certificates

TLS certificate management with automatic ACME issuance and load balancer integration

11 methods

GET

list_certificates()

List certificates

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

status

string

- Filter by certificate status

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.list_certificates()
print(result)

POST

create_certificate()

Create certificate

Parameters

name

string

required

- Name of the certificate

type

string

required

domains

array

- List of domains for ACME certificate (supports multi-domain and wildcard certs)

certificate

string

- PEM-encoded certificate (required when type is 'uploaded')

private_key

string

- PEM-encoded private key (required when type is 'uploaded')

chain

string

- PEM-encoded certificate chain (optional for uploaded certificates)

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.create_certificate(name="my-certificate", type="acme")
print(result)

GET

get_certificate()

Get certificate

Parameters

certificate_id

string

required

- Certificate ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.get_certificate(certificate_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_certificate()

Delete certificate

Parameters

certificate_id

string

required

- Certificate ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.delete_certificate(certificate_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

list_bindings()

List certificate bindings

Parameters

certificate_id

string

required

- Certificate ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.list_bindings(certificate_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

POST

create_binding()

Create certificate binding

Parameters

certificate_id

string

required

- Certificate ID

resource_type

string

required

- The type of resource to bind the certificate to

resource_id

string

required

- The ID of the resource to bind to

options

object

- Binding options

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.create_binding(certificate_id="550e8400-e29b-41d4-a716-446655440000", resource_type="octavia:listener", resource_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

get_binding()

Get certificate binding

Parameters

certificate_id

string

required

- Certificate ID

binding_id

string

required

- Certificate Binding ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.get_binding(certificate_id="550e8400-e29b-41d4-a716-446655440000", binding_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_binding()

Delete certificate binding

Parameters

certificate_id

string

required

- Certificate ID

binding_id

string

required

- Certificate Binding ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.delete_binding(certificate_id="550e8400-e29b-41d4-a716-446655440000", binding_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

POST

renew_certificate()

Renew certificate

Parameters

certificate_id

string

required

- Certificate ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.renew_certificate(certificate_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

POST

validate_certificate()

Validate certificate DNS

Parameters

certificate_id

string

required

- Certificate ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.validate_certificate(certificate_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

list_listener_certificates()

List listener certificates

Parameters

load_balancer_id

string

required

- Load Balancer ID

listener_id

string

required

- Listener ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.certificates.list_listener_certificates(load_balancer_id="550e8400-e29b-41d4-a716-446655440000", listener_id="550e8400-e29b-41d4-a716-446655440000")
print(result)