Certificate

Download schema

The Load Balancer certificate object. It represents an SSL/TLS certificate for your Load Balancer which can be used by a frontend to establish secure, encrypted connections for incoming traffic. Use this endpoint to create Let's Encrypt certificates or import custom certificates for your Load Balancer, and update, list, get and delete them as required.

Get an SSL/TLS certificate

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/certificates/{certificate_id}

Get information for a particular SSL/TLS certificate, specified by its certificate ID. The response returns full details of the certificate, including its type, main domain name, and alternative domain names.

Get an SSL/TLS certificate › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

certificate_id

string · required

Certificate ID.

Get an SSL/TLS certificate › Responses

200

scaleway.lb.v1.Certificate

type

scaleway.lb.v1.Certificate.Type · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string | null · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string | null · date-time

Upper validity bound. (RFC 3339 format)

status

scaleway.lb.v1.Certificate.Status · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

scaleway.lb.v1.Lb

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string | null · date-time

Date on which the certificate was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the certificate was last updated. (RFC 3339 format)

status_details

string | null

Additional information about the certificate status (useful in case of certificate generation failure, for example).

GET/lb/v1/zones/{zone}/certificates/{certificate_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/zones/{zone}/certificates/{certificate_id}"

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "lb": {
    "id": "id",
    "name": "name",
    "description": "description",
    "status": "unknown",
    "instances": [
      {
        "id": "id",
        "status": "unknown",
        "ip_address": "ip_address",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "region": "region",
        "zone": "zone"
      }
    ],
    "organization_id": "organization_id",
    "project_id": "project_id",
    "ip": [
      {
        "id": "id",
        "ip_address": "ip_address",
        "organization_id": "organization_id",
        "project_id": "project_id",
        "lb_id": "lb_id",
        "reverse": "reverse",
        "tags": [
          "string"
        ],
        "region": "region",
        "zone": "zone"
      }
    ],
    "tags": [
      "string"
    ],
    "frontend_count": 0,
    "backend_count": 0,
    "type": "type",
    "subscriber": {
      "id": "id",
      "name": "name",
      "email_config": {
        "email": "email"
      },
      "webhook_config": {
        "uri": "uri"
      }
    },
    "ssl_compatibility_level": "ssl_compatibility_level_unknown",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "private_network_count": 0,
    "route_count": 0,
    "region": "region",
    "zone": "zone"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

json

application/json

Update an SSL/TLS certificate

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/certificates/{certificate_id}

Update the name of a particular SSL/TLS certificate, specified by its certificate ID.

Update an SSL/TLS certificate › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

certificate_id

string · required

Certificate ID.

Update an SSL/TLS certificate › Request Body

name

string · required

Certificate name.

Update an SSL/TLS certificate › Responses

200

scaleway.lb.v1.Certificate

type

scaleway.lb.v1.Certificate.Type · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string | null · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string | null · date-time

Upper validity bound. (RFC 3339 format)

status

scaleway.lb.v1.Certificate.Status · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

scaleway.lb.v1.Lb

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string | null · date-time

Date on which the certificate was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the certificate was last updated. (RFC 3339 format)

status_details

string | null

Additional information about the certificate status (useful in case of certificate generation failure, for example).

PUT/lb/v1/zones/{zone}/certificates/{certificate_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/certificates/{certificate_id}"

Example Request Body

{
  "name": "name"
}

json

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "lb": {
    "id": "id",
    "name": "name",
    "description": "description",
    "status": "unknown",
    "instances": [
      {
        "id": "id",
        "status": "unknown",
        "ip_address": "ip_address",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "region": "region",
        "zone": "zone"
      }
    ],
    "organization_id": "organization_id",
    "project_id": "project_id",
    "ip": [
      {
        "id": "id",
        "ip_address": "ip_address",
        "organization_id": "organization_id",
        "project_id": "project_id",
        "lb_id": "lb_id",
        "reverse": "reverse",
        "tags": [
          "string"
        ],
        "region": "region",
        "zone": "zone"
      }
    ],
    "tags": [
      "string"
    ],
    "frontend_count": 0,
    "backend_count": 0,
    "type": "type",
    "subscriber": {
      "id": "id",
      "name": "name",
      "email_config": {
        "email": "email"
      },
      "webhook_config": {
        "uri": "uri"
      }
    },
    "ssl_compatibility_level": "ssl_compatibility_level_unknown",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "private_network_count": 0,
    "route_count": 0,
    "region": "region",
    "zone": "zone"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

json

application/json

Delete an SSL/TLS certificate

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/certificates/{certificate_id}

Delete an SSL/TLS certificate, specified by its certificate ID. Deleting a certificate is irreversible and cannot be undone.

Delete an SSL/TLS certificate › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

certificate_id

string · required

Certificate ID.

Delete an SSL/TLS certificate › Responses

No data returned

List all SSL/TLS certificates on a given Load Balancer

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/certificates

List all the SSL/TLS certificates on a given Load Balancer. The response is an array of certificate objects, which are by default listed in ascending order of creation date.

List all SSL/TLS certificates on a given Load Balancer › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

List all SSL/TLS certificates on a given Load Balancer › query Parameters

order_by

scaleway.lb.v1.ListCertificatesRequest.OrderBy · enum

Sort order of certificates in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

Number of certificates to return.

name

string

Certificate name to filter for, only certificates of this name will be returned.

List all SSL/TLS certificates on a given Load Balancer › Responses

200

scaleway.lb.v1.ListCertificatesResponse

scaleway.lb.v1.Certificate[]

List of certificate objects.

total_count

integer · uint32

The total number of objects.

GET/lb/v1/zones/{zone}/lbs/{lb_id}/certificates

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/certificates"

Example Responses

{
  "certificates": [
    {
      "type": "letsencryt",
      "id": "id",
      "common_name": "common_name",
      "subject_alternative_name": [
        "string"
      ],
      "fingerprint": "fingerprint",
      "not_valid_before": "2022-03-22T12:34:56.123456Z",
      "not_valid_after": "2022-03-22T12:34:56.123456Z",
      "status": "pending",
      "lb": {
        "id": "id",
        "name": "name",
        "description": "description",
        "status": "unknown",
        "instances": [
          {
            "id": "id",
            "status": "unknown",
            "ip_address": "ip_address",
            "created_at": "2022-03-22T12:34:56.123456Z",
            "updated_at": "2022-03-22T12:34:56.123456Z",
            "region": "region",
            "zone": "zone"
          }
        ],
        "organization_id": "organization_id",
        "project_id": "project_id",
        "ip": [
          {
            "id": "id",
            "ip_address": "ip_address",
            "organization_id": "organization_id",
            "project_id": "project_id",
            "lb_id": "lb_id",
            "reverse": "reverse",
            "tags": [
              "string"
            ],
            "region": "region",
            "zone": "zone"
          }
        ],
        "tags": [
          "string"
        ],
        "frontend_count": 0,
        "backend_count": 0,
        "type": "type",
        "subscriber": {
          "id": "id",
          "name": "name",
          "email_config": {
            "email": "email"
          },
          "webhook_config": {
            "uri": "uri"
          }
        },
        "ssl_compatibility_level": "ssl_compatibility_level_unknown",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "private_network_count": 0,
        "route_count": 0,
        "region": "region",
        "zone": "zone"
      },
      "name": "name",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "status_details": "status_details"
    }
  ],
  "total_count": 0
}

json

application/json

Create an SSL/TLS certificate

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/certificates

Generate a new SSL/TLS certificate for a given Load Balancer. You can choose to create a Let's Encrypt certificate, or import a custom certificate.

Create an SSL/TLS certificate › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

Create an SSL/TLS certificate › Request Body

name

string · required

Name for the certificate.

Object to define a new Let's Encrypt certificate to be generated.

Object to define an existing custom certificate to be imported.

Create an SSL/TLS certificate › Responses

200

scaleway.lb.v1.Certificate

type

scaleway.lb.v1.Certificate.Type · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string | null · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string | null · date-time

Upper validity bound. (RFC 3339 format)

status

scaleway.lb.v1.Certificate.Status · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

scaleway.lb.v1.Lb

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string | null · date-time

Date on which the certificate was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the certificate was last updated. (RFC 3339 format)

status_details

string | null

Additional information about the certificate status (useful in case of certificate generation failure, for example).

POST/lb/v1/zones/{zone}/lbs/{lb_id}/certificates

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/certificates"

Example Request Body

{
  "name": "name",
  "letsencrypt": {
    "common_name": "common_name",
    "subject_alternative_name": [
      "string"
    ]
  },
  "custom_certificate": {
    "certificate_chain": "certificate_chain"
  }
}

json

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "lb": {
    "id": "id",
    "name": "name",
    "description": "description",
    "status": "unknown",
    "instances": [
      {
        "id": "id",
        "status": "unknown",
        "ip_address": "ip_address",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "region": "region",
        "zone": "zone"
      }
    ],
    "organization_id": "organization_id",
    "project_id": "project_id",
    "ip": [
      {
        "id": "id",
        "ip_address": "ip_address",
        "organization_id": "organization_id",
        "project_id": "project_id",
        "lb_id": "lb_id",
        "reverse": "reverse",
        "tags": [
          "string"
        ],
        "region": "region",
        "zone": "zone"
      }
    ],
    "tags": [
      "string"
    ],
    "frontend_count": 0,
    "backend_count": 0,
    "type": "type",
    "subscriber": {
      "id": "id",
      "name": "name",
      "email_config": {
        "email": "email"
      },
      "webhook_config": {
        "uri": "uri"
      }
    },
    "ssl_compatibility_level": "ssl_compatibility_level_unknown",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "private_network_count": 0,
    "route_count": 0,
    "region": "region",
    "zone": "zone"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

json

application/json

ACLs Load Balancer Types