# TerminatePort

## 1. API Description

This API is used to terminate a port.

#### Prerequisites

Before terminating a port, you can call [`DescribePorts`](https://docs.console.zenlayer.com/api-reference/networking/sdn/describeports#DescribePorts) to query port list.

{% hint style="info" %} <mark style="color:blue;">**Note**</mark>

* <mark style="color:blue;">Use this API to return a port that is no longer required. A pay-as-you-go port will stop billing after it is returns.</mark>
* <mark style="color:blue;">You cannot return a subscription port using this API, which will be returned when subscription expires.</mark>
* <mark style="color:blue;">When this API is called, the port will be moved to the recycle bin and be released in 24 hours if there are no other operations. You can also call</mark> [<mark style="color:purple;">DestroyPort</mark>](https://docs.console.zenlayer.com/api-reference/networking/sdn/destroyport#DestroyPort) <mark style="color:blue;">to release the elastic IP.</mark>
* <mark style="color:blue;">Operations on ports in recycle bin or in creating status are not supported.</mark>
  {% endhint %}

## 2. Input Parameters

The following request parameter list only provides API request parameters.

<table><thead><tr><th width="188">Parameter Name</th><th width="115">Required</th><th width="102">Type</th><th>Description</th></tr></thead><tbody><tr><td>portId</td><td>Yes</td><td>String</td><td>Port ID.</td></tr></tbody></table>

## 3. Output Parameters

<table><thead><tr><th width="193.33333333333331">Parameter Name</th><th width="102">Type</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>The unique request ID, which is returned for each request. RequestId is required for locating a problem.</td></tr></tbody></table>

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Terminate a port.**

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

Request:
{
  "portId": "your-port-id"
}

Response:
{
  "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2",
  "response": {
    "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk) 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](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).​

<table><thead><tr><th width="201.33333333333331">HTTP Status Code</th><th width="301">Error Code</th><th>Description</th></tr></thead><tbody><tr><td>7105</td><td>SELF_SERVICE_PORT_NOT_FOUND</td><td>Port not found.</td></tr></tbody></table>