Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Viewing the Source of Repository Inheritance Settings
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Viewing the Source of Repository Inheritance Settings

Function

This API is used to view the source of repository inheritance settings.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/inherit-setting-source

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can call the API used to query all repositories of the user to query the project list to obtain the repository ID.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Set the name.

Constraints

N/A

Range

  • protected_branches: Protected branch.

  • protected_tags: Protected tag.

  • merge_requests: Merge request.

Default Value

N/A

Enumeration values:

  • protected_branches

  • protected_tags

  • merge_requests

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

source_type

String

Definition:

Source type.

Value range:

  • project: Project.

  • group: Repository group.

  • repository: Repository.

Enumeration values:

  • project

  • group

  • repository

source_id

String

Definition:

Source ID.

Value range:

1–2147483647

upward_inherit_editable

Boolean

Definition:

Whether the inheritance settings can be modified.

Value range:

  • true: Yes.

  • false: No.

Example Requests

None

Example Responses

Status code: 200

Source of repository inheritance settings.

{
  "source_type" : "repository",
  "source_id" : "2112024386",
  "upward_inherit_editable" : true
}

Status Codes

Status Code

Description

200

Source of repository inheritance settings.

Error Codes

See Error Codes.

Parent topic: Repository