Updated on 2024-03-25 GMT+08:00

Deleting a Custom Line

Function

This API is used to delete a custom line.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2.1/customlines/{line_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

line_id

Yes

String

Resolution line ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

line_id

String

Resolution line ID

name

String

Custom line name

ip_segments

Array of strings

IP address range

created_at

String

Time when the custom line was created

updated_at

String

Time when the custom line was updated

status

String

Resource status

description

String

Custom line description

Example Requests

None

Example Responses

Status code: 200

Response to the request for deleting a custom line

{
  "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007",
  "name" : "customline",
  "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ],
  "status" : "PENDING_DELETE",
  "created_at" : "2019-04-10T12:03:17.827",
  "updated_at" : "2019-04-10T12:03:17.827",
  "description" : "123"
}

Status Codes

Status Code

Description

200

Response to the request for deleting a custom line

Error Codes

See Error Codes.