Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V1)/ Connection Management APIs (To Be Taken Offline)/ Deleting a Connection (to Be Taken Offline)
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Deleting a Connection (to Be Taken Offline)

The connection management capability is provided by Management Center. This API is no longer maintained. You are advised to use the APIs in Management Center for connection management.

Function

This API is used to delete a connection.

URI

  • URI format

    DELETE /v1/{project_id}/connections/{connection_name}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

    connection_name

    Yes

    String

    Name of a connection.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

Response Parameters

None.

Example Request

Delete the connection. 
DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/connection1

Example Response

Success response

HTTP status code 204

Parent Topic: Connection Management APIs (To Be Taken Offline)