Help Center/ CodeArts PerfTest/ API Reference/ API/ Directory Management/ Modifying a Directory
Updated on 2026-02-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Directory

Function

This API is used to modify a directory.

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

    codeartsperftest:cpts:updatePerfTestProject

    Write

    cpts *

    g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v1/{project_id}/test-suites/{test_suite_id}/directory/{directory_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

directory_id

Yes

Integer

Directory ID, which is the value of directory_id in the response body of the API for creating a directory.

project_id

Yes

String

Project ID. For details, see Method of obtaining instructions.

test_suite_id

Yes

Integer

Test project ID, which is the value of project_id in the response body of the API for creating a project.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Directory name.

Response Parameters

Status code: 204

The directory is successfully updated.

None

Example Requests

Modifying the information about a directory. The directory ID is 1, the ID of the project to which the directory belongs is 3, and the directory name is test.

/v1/{project_id}/test-suites/3/directory/1

{
  "name" : "test"
}

Example Responses

None

Status Codes

Status Code

Description

204

The directory is successfully updated.

Error Codes

See Error Codes.

Parent topic: Directory Management