Contact UsGet started

Object Storage API, REST: Bucket.SetHTTPSConfig

Written by
Updated at October 17, 2024

Updates the HTTPS configuration for the specified bucket.

The updated configuration could take up to 30 minutes to apply to the bucket.

HTTP request

POST https://storage.api.cloud.yandex.net/storage/v1/buckets/{name}:setHttpsConfig

Path parameters

Field

Description

name

string

Required field. Name of the bucket to update the HTTPS configuration for.

Body parameters

{
  // Includes only one of the fields `selfManaged`, `certificateManager`
  "selfManaged": {
    "certificatePem": "string",
    "privateKeyPem": "string"
  },
  "certificateManager": {
    "certificateId": "string"
  }
  // end of the list of possible fields
}

Field

Description

selfManaged

SelfManagedHTTPSConfigParams

Your TLS certificate, uploaded directly.

Object Storage only supports PEM-encoded certificates.

Includes only one of the fields selfManaged, certificateManager.

HTTPS configuration parameters.

certificateManager

CertificateManagerHTTPSConfigParams

TLS certificate from Certificate Manager.

To create a certificate in Certificate Manager, make a
yandex.cloud.certificatemanager.v1.CertificateService.Create request.

Includes only one of the fields selfManaged, certificateManager.

HTTPS configuration parameters.

SelfManagedHTTPSConfigParams

Field

Description

certificatePem

string

PEM-encoded certificate.

privateKeyPem

string

PEM-encoded private key for the certificate.

CertificateManagerHTTPSConfigParams

A resource for a TLS certificate from Certificate Manager.

Field

Description

certificateId

string

ID of the certificate.

To get the list of all available certificates, make a yandex.cloud.certificatemanager.v1.CertificateService.List
request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "sourceType": "string",
    "issuer": "string",
    "subject": "string",
    "dnsNames": [
      "string"
    ],
    "notBefore": "string",
    "notAfter": "string",
    "certificateId": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

SetBucketHTTPSConfigMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

HTTPSConfig

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

SetBucketHTTPSConfigMetadata

Field

Description

name

string

Name of the bucket the HTTPS configuration is being updated for.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

HTTPSConfig

A resource for HTTPS configuration of a bucket.

Field

Description

name

string

Name of the bucket.

sourceType

enum (SourceType)

Type of TLS certificate source.

  • SOURCE_TYPE_UNSPECIFIED
  • SOURCE_TYPE_SELF_MANAGED: Your certificate, uploaded directly.
  • SOURCE_TYPE_MANAGED_BY_CERTIFICATE_MANAGER: Certificate managed by Certificate Manager.

issuer

string

Issuer of the TLS certificate.

subject

string

Subject of the TLS certificate.

dnsNames[]

string

List of DNS names of the TLS certificate (Subject Alternative Name field).

notBefore

string (date-time)

Start of the TLS certificate validity period (Not Before field).

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

notAfter

string (date-time)

End of the TLS certificate validity period (Not After field)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

certificateId

string

ID of the TLS certificate in Certificate Manager.

To get information about the certificate from Certificate Manager, make a
yandex.cloud.certificatemanager.v1.CertificateService.Get request.
Previous
GetHTTPSConfig
Next
DeleteHTTPSConfig