Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Domain Name Management/ Modifying a Domain Name
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Domain Name

Function

This API is used to modify the configuration of a domain name bound to an API group.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

group_id

Yes

String

API group ID.

domain_id

Yes

String

Domain ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

min_ssl_version

Yes

String

Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.

is_http_redirect_to_https

No

Boolean

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

verified_client_certificate_enabled

No

Boolean

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

url_domain

String

Custom domain name.

id

String

Domain ID.

status

Integer

CNAME resolution status.

  • 1: not parsed

  • 2: parsing

  • 3: parsing succeeded

  • 4: parsing failed

min_ssl_version

String

Minimum SSL version supported.

is_http_redirect_to_https

Boolean

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

verified_client_certificate_enabled

Boolean

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Modify configurations of a bound domain name by changing the earliest SSL version to TLS 1.2.

{
  "min_ssl_version" : "TLSv1.2"
}

Example Responses

Status code: 201

Created

{
  "id" : "0a515af69f4e4dcca84fbf85f68c0e27",
  "url_domain" : "www.example.com",
  "status" : 3,
  "min_ssl_version" : "TLSv1.2",
  "is_http_redirect_to_https" : false,
  "verified_client_certificate_enabled" : false
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.3474",
  "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3020",
  "error_msg" : "The URL domain does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Domain Name Management