Help Center/ ROMA Connect/ API Reference/ Out-of-Date APIs/ APIC APIs (V1)/ API Management (V1)/ Deleting APIs
Updated on 2023-06-29 GMT+08:00
View PDF

Deleting APIs

Function

This API is used to delete specified APIs or all APIs in a specified group.

URI

PUT /v1/{project_id}/apic/instances/{instance_id}/apis

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Operation to perform.

  • delete

Currently, only the delete operation is supported.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

group_id

No

String

IDs of the API groups to be deleted.

apis

No

Array of strings

IDs of the APIs to be deleted.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

failure

Array of BatchFailure objects

Error message and APIs that fail to be deleted.

success_count

Long

Number of APIs that have been successfully deleted.
Table 6 BatchFailure

Parameter

Type

Description

api_id

String

ID of an API that fails to be deleted.

api_name

String

Name of the API that fails to be operated.

error_code

String

Error code.

error_msg

String

Error information generated after an operation fails.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "apis" : [ "b20a5be94ded40cc8f2872ea3005cfb7", "5f918d104dc84480a75166ba99efff21" ]
}

Example Responses

Status code: 200

OK

{
  "success_count" : 1,
  "failure" : [ {
    "error_code" : "APIG.3002",
    "error_msg" : "API b20a5be94ded40cc8f2872ea3005cfb7 does not exist",
    "api_id" : "b20a5be94ded40cc8f2872ea3005cfb7"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value: parameter action should be \\\"delete\\\""
}

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: API Management (V1)