Help Center/ DataArts Fabric/ API Reference/ APIs/ Endpoint Management/ Deleting an Endpoint
Updated on 2025-09-15 GMT+08:00
View PDF
Share

Deleting an Endpoint

Function

This API is used to delete an endpoint. You can call this API to delete an endpoint within a workspace by entering the endpoint ID. The operation result will then be returned. This is an asynchronous API. It is used in conjunction with the ShowEndpoint API to query information about an endpoint, with no specific scenarios involved.

URI

DELETE /v1/workspaces/{workspace_id}/endpoints/{endpoint_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

workspace_id

Yes

String

Definition: Workspace ID. For how to obtain a workspace ID, see [Obtaining a Workspace ID] (dataartsfabric_03_0022.xml).

Constraints: N/A.

Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.

endpoint_id

Yes

String

Definition: Endpoint ID. For how to obtain an endpoint ID, see [Obtaining an Endpoint ID] (dataartsfabric_03_0023.xml).

Constraints: N/A.

Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

is_delete_app_instance

No

Boolean

Definition: Whether to delete all running job instances of a Ray endpoint upon its deletion.

Constraints: N/A.

Range: true or false.

Default Value: false.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml).

Constraints: N/A.

Range: Up to 65,534 characters.

Default Value: N/A.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition: endpoint ID.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 408

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Example Requests

DELETE https://{endpoint}/v1/workspaces/{workspace_id}/endpoints/{endpoint_id}

Example Responses

Status code: 202

An endpoint is deleted.

{
  "id" : "ac8111bf-3601-4905-8ddd-b41d3e636a4e"
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

202

An endpoint is deleted.

400

BadRequest

401

Unauthorized

403

Forbidden

408

Request Time-out

500

InternalServerError

Error Codes

See Error Codes.

Parent topic: Endpoint Management