Updated on 2026-05-30 GMT+08:00

Enabling or Disabling SSL (a V3 API)

Function

This API is used to configure SSL to encrypt connections.

Constraints

None

URI

POST /v3/{project_id}/instances/{instance_id}/switch-ssl

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

You can obtain the token by calling the IAM API used to obtain a user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ssl_enabled

Yes

Boolean

true: SSL is enabled.

false: SSL is disabled.

Example Request

Enabling SSL
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/switch-ssl
{
  "ssl_enabled" : true
}

Response Parameters

  • Normal response
    Table 4 Response body parameters

    Parameter

    Type

    Description

    job_id

    String

    Job ID.

Example Response

  • Normal response example
    {
      "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
    }

Status Codes

Error Codes

For details, see Error Codes.