Help Center/ CodeArts Pipeline/ API Reference/ API/ Endpoint Management/ Querying Endpoint Permissions
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Endpoint Permissions

Function

This API is used to query endpoint permissions.

Calling Method

For details, see Calling APIs.

URI

GET /v1/endpoint/{endpointUuid}/permission

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

endpointUuid

Yes

String

Definition:

Endpoint UUID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

error

ErrorInfo object

Definition:

Error message.

Value range:

N/A

result

Map<String,EndpointPermissionList>

Definition:

Information about the endpoint permissions.

Value range:

N/A

status

String

Definition:

Status value.

Value range:

N/A
Table 3 ErrorInfo

Parameter

Type

Description

code

String

Definition:

Error code.

Value range:

N/A

message

String

Definition:

Error message.

Value range:

N/A
Table 4 EndpointPermissionList

Parameter

Type

Description

endpoints

Array of EndpointPermission objects

Definition:

Endpoint permission list.

Value range:

N/A
Table 5 EndpointPermission

Parameter

Type

Description

id

Integer

Definition:

Permission ID.

Value range:

N/A

endpoint_uuid

String

Definition:

Endpoint ID.

Value range:

N/A

role_name

String

Definition:

Permission name.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Endpoint Management