vpc · 2017-03-12

CreateAddressTemplate

POST

Create an IP address template.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/CreateAddressTemplate path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: CreateAddressTemplate' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AddressTemplateName":"<AddressTemplateName>","Addresses":"<Addresses>"}'

Request parameters

Field	Type	Required	Description
AddressTemplateName	string	Yes	IP address template name.
Addresses	string[]	Yes	The address information can be presented by the IP, CIDR block or IP address range. Either Addresses or AddressesExtra is required.
AddressesExtra	AddressInfo[]	No	The address information can contain remarks and be presented by the IP, CIDR block or IP address range. Either Addresses or AddressesExtra is required.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
AddressTemplate	AddressTemplate	The template object of the IP address.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "AddressTemplate": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · CreateAddressTemplate

{
  "AddressTemplateName": "<AddressTemplateName>",
  "Addresses": "<Addresses>"
}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "AddressTemplate": {
      "AddressTemplateName": "example-network",
      "AddressTemplateId": "ipm-anj9nphw",
      "AddressSet": [
        "10.0.0.0/8",
        "192.168.1.1"
      ],
      "AddressExtraSet": [
        {
          "Address": "10.0.0.0/8",
          "Description": ""
        },
        {
          "Address": "192.168.1.1",
          "Description": ""
        }
      ],
      "CreatedTime": "2026-09-16 19:51:29"
    },
    "RequestId": "761bd4f5-63e0-de9c-090a-046bfbc96f8f"
  }
}