Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Dedicated - API Management/ Deleting APIs in Batches
Updated on 2026-05-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting APIs in Batches

Function

This API is used to delete APIs in batches.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    apig:api:batchDelete

    Write

    instance *

    g:ResourceTag/<tag-key>

    apig:apis:delete
    • apig:instance:get
    • apig:apiGroup:get

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apis

No

Array of strings

IDs of the APIs to delete.

group_id

No

String

ID of the API group to which the APIs to delete belong.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of APIs to delete.

success_count

Integer

Number of APIs that have been successfully deleted.

failure

BatchFailure object

Response of a batch operation failure.
Table 5 BatchFailure

Parameter

Type

Description

api_id

String

ID of an API that fails to be published or taken offline.

api_name

String

Name of an API that fails to be published or taken offline.

error_code

String

Error code.

error_msg

String

Error message.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Delete specified APIs in batches.

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

Example Responses

Status code: 200

OK

{
  "total_count" : 2,
  "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.