rules

List repo protection rules

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.
query	string The substring by which the repository protection rules are filtered.
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
sort	string Default: "created_at" The field by which the protection rules are sorted. Enum: "created_at" "identifier" "uid" "updated_at"
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
inherited	boolean Default: false The result should inherit entities from parent spaces.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/rules

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}
]

Add repo protection rule

Securityx-api-key

Request

path Parameters

repo_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Request Body schema: application/json

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string
identifier	string
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string Deprecated

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/rules

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

Delete repo protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Get repo protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

Update repo protection rule

Securityx-api-key

Request

path Parameters

repo_identifier required	string
rule_identifier required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Request Body schema: application/json

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string or null
identifier	string or null
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string or null Deprecated

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

List acc/org/proj protection rules

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.
query	string The substring by which the repository protection rules are filtered.
order	string Default: "asc" The order of the output. Enum: "asc" "desc"
sort	string Default: "created_at" The field by which the protection rules are sorted. Enum: "created_at" "identifier" "uid" "updated_at"
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
inherited	boolean Default: false The result should inherit entities from parent spaces.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/rules

Request samples

curl
Java
Go

Response samples

application/json

[{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}
]

Add acc/org/proj protection rule

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Request Body schema: application/json

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string
identifier	string
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string Deprecated

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/rules

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

Delete acc/org/proj protection rule

Securityx-api-key

Request

path Parameters

rule_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/rules/{rule_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"message": "string",
"values": {"property1": null,
"property2": null
}
}

Get acc/org/proj protection rule

Securityx-api-key

Request

path Parameters

rule_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/rules/{rule_identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

Update acc/org/proj protection rule

Securityx-api-key

Request

path Parameters

rule_identifier

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.

Request Body schema: application/json

	ProtectionBranch (object) (OpenapiRuleDefinition)
description	string or null
identifier	string or null
	object or null (ProtectionPattern)
state	string or null (EnumRuleState) Enum: "active" "disabled" "monitor"
type	string (OpenapiRuleType) Value: "branch"
uid	string or null Deprecated

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/rules/{rule_identifier}

Request samples

Payload
curl
Java
Go

application/json

{"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"state": "active",
"type": "branch",
"uid": "string"
}

Response samples

application/json

{"created": 0,
"created_by": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"definition": {"bypass": {"repo_owners": true,
"user_group_ids": [0
],
"user_ids": [0
]
},
"lifecycle": {"create_forbidden": true,
"delete_forbidden": true,
"update_forbidden": true,
"update_force_forbidden": true
},
"pullreq": {"approvals": {"require_code_owners": true,
"require_latest_commit": true,
"require_minimum_count": 0,
"require_no_change_request": true
},
"comments": {"require_resolve_all": true
},
"merge": {"block": true,
"delete_branch": true,
"strategies_allowed": ["fast-forward"
]
},
"status_checks": {"require_identifiers": ["string"
]
}
}
},
"description": "string",
"identifier": "string",
"pattern": {"default": true,
"exclude": ["string"
],
"include": ["string"
]
},
"scope": 0,
"state": "active",
"type": "branch",
"updated": 0,
"user_groups": {"property1": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
},
"property2": {"description": "string",
"id": 0,
"identifier": "string",
"name": "string"
}
},
"users": {"property1": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
},
"property2": {"created": 0,
"display_name": "string",
"email": "string",
"id": 0,
"type": "service",
"uid": "string",
"updated": 0
}
}
}

➔ Next to labels