1. API Description

This API is used to return a CIDR block.


  • Use this API to return a CIDR block that is no longer required. A pay-as-you-go CIDR block will stop billing after it is returns.

  • You cannot return a subscription CIDR block using this API, which will be returned when subscription expires.

  • You cannot return the CIDR block if the IP in it is assigned to an instance. Please unassign all the instances before returning the CIDR block.

  • The returned IPv4 CIDR block will be moved to the recycle bin and be released in 24 hours if there are no other operations. You can also call ReleaseCidrBlocks to release it.

  • The returned IPv4 CIDR block will be released directly.

  • Operations on CIDR blocks in recycle bin or in CREATING status are not supported.

  • Operations on CIDR block in CREATE_FAILED status will delete the CIDR block directly. For prepaid CIDR blocks, all payment amounts will be refunded.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter NameRequiredTypeDescription




ID of the CIDR block.

You can find the cidrBlockId in the response by calling DescribeCidrBlocks.

3. Output Parameters

Parameter NameTypeDescription



The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Return a CIDR block.

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: TerminateCidrBlock
<Common Request Params>

  "cidrBlockId": "cidrBlockId"

  "requestId": "TC9E90021-5016-455C-B2F4-9D640EF63176",
  "response": {
    "requestId": "TC9E90021-5016-455C-B2F4-9D640EF63176"

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status CodeError CodeDescription



Return on prepaid CIDR blocks not supported.



Return on CIDR blocks with instances assigned not supported.

Last updated