vpc · 2017-03-12

ReleaseAddresses

POST

Release one or multiple Elastic IPs.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/ReleaseAddresses 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: ReleaseAddresses' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AddressIds":["<AddressId>"]}'

Request parameters

Field	Type	Required	Description
AddressIds	string[]	Yes	The unique ID list of the EIP. The unique ID of an EIP is as follows: `eip-11112222`.

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
TaskId	string	The async task ID. You can use the DescribeTaskResult API to query the task status.
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": {
    "TaskId": …,
    "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 · ReleaseAddresses

{
  "AddressIds": [
    "<AddressId>"
  ]
}

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

Recorded example response — captured 2026-09-17

{
  "Response": {
    "TaskId": "23069",
    "RequestId": "99c58374-176b-ae87-20de-fc3d1a08f08c"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "InvalidAddressId.StatusNotPermit",
      "Message": "The status `\"BIND_ENI\"` for AddressId `\"eip-f72l2q9u\"` is not permit to do this operation."
    },
    "RequestId": "844bfdba-2067-70c0-fc71-7d573b258de9"
  }
}

Recorded error 2

{
  "Response": {
    "Error": {
      "Code": "InvalidAddressId.StatusNotPermit",
      "Message": "The status `\"BIND_ENI\"` for AddressId `\"eip-f72l2q9u\"` is not permit to do this operation."
    },
    "RequestId": "ec4b1fdd-b58c-41e2-f90e-72d40cfb43f9"
  }
}

Behaviour

Rejected with InvalidAddressId.StatusNotPermit while the address is attached. Detach it and wait for AddressStatus UNBIND first. A released address reads back as an empty set.