labels

List labels at account, org or project level

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.
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.
query	string The substring which is used to filter the labels by their key.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/labels

Request samples

curl
Java
Go

Response samples

application/json

[{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}
]

Create label at account, org or project level

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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
description	string
key	string
type	string (EnumLabelType) Enum: "dynamic" "static"

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/labels

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"description": "string",
"key": "string",
"type": "dynamic"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}

Save label and values at account, org or project level

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

	object (TypesSaveLabelInput)
	Array of objects (TypesSaveLabelValueInput)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/code/api/v1/labels

Request samples

Payload
curl
Java
Go

application/json

{"label": {"color": "blue",
"description": "string",
"id": 0,
"key": "string",
"type": "dynamic"
},
"values": [{"color": "blue",
"id": 0,
"value": "string"
}
]
}

Response samples

application/json

{"label": {"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
},
"values": [{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}
]
}

Delete label at account, org or project level

Securityx-api-key

Request

path Parameters

key

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/labels/{key}

Request samples

curl
Java
Go

Response samples

application/json

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

Update label at account, org or project level

Securityx-api-key

Request

path Parameters

key

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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
description	string
key	string
type	string (EnumLabelType) Enum: "dynamic" "static"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/labels/{key}

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"description": "string",
"key": "string",
"type": "dynamic"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}

List label values at account, org or project level

Securityx-api-key

Request

path Parameters

key

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/labels/{key}/values

Request samples

curl
Java
Go

Response samples

application/json

[{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}
]

Create label value at account, org or project level

Securityx-api-key

Request

path Parameters

key

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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
value	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/labels/{key}/values

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"value": "string"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}

Delete label value at account, org or project level

Securityx-api-key

Request

path Parameters

key required	string
value 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/labels/{key}/values/{value}

Request samples

curl
Java
Go

Response samples

application/json

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

Update label value at account, org or project level

Securityx-api-key

Request

path Parameters

key required	string
value 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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
value	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/labels/{key}/values/{value}

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"value": "string"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}

List labels at repo level

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.
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.
query	string The substring which is used to filter the labels by their key.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

curl
Java
Go

Response samples

application/json

[{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}
]

Create label at repo level

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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
description	string
key	string
type	string (EnumLabelType) Enum: "dynamic" "static"

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"description": "string",
"key": "string",
"type": "dynamic"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}

Save label and values at repo level

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

	object (TypesSaveLabelInput)
	Array of objects (TypesSaveLabelValueInput)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/labels

Request samples

Payload
curl
Java
Go

application/json

{"label": {"color": "blue",
"description": "string",
"id": 0,
"key": "string",
"type": "dynamic"
},
"values": [{"color": "blue",
"id": 0,
"value": "string"
}
]
}

Response samples

application/json

{"label": {"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
},
"values": [{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}
]
}

Delete label at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/labels/{key}

Request samples

curl
Java
Go

Response samples

application/json

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

Update label at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key 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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
description	string
key	string
type	string (EnumLabelType) Enum: "dynamic" "static"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/labels/{key}

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"description": "string",
"key": "string",
"type": "dynamic"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"description": "string",
"id": 0,
"key": "string",
"repo_id": 0,
"scope": 0,
"space_id": 0,
"type": "dynamic",
"updated": 0,
"updated_by": 0,
"value_count": 0
}

List label values at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/labels/{key}/values

Request samples

curl
Java
Go

Response samples

application/json

[{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}
]

Create label value at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key 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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
value	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/code/api/v1/repos/{repo_identifier}/labels/{key}/values

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"value": "string"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}

Delete label value at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key required	string
value 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}

Request samples

curl
Java
Go

Response samples

application/json

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

Update label value at repo level

Securityx-api-key

Request

path Parameters

repo_identifier required	string
key required	string
value 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

color	string (EnumLabelColor) Enum: "blue" "brown" "cyan" "green" "indigo" "lime" "mint" "orange" "pink" "purple" "red" "violet" "yellow"
value	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}

Request samples

Payload
curl
Java
Go

application/json

{"color": "blue",
"value": "string"
}

Response samples

application/json

{"color": "blue",
"created": 0,
"created_by": 0,
"id": 0,
"label_id": 0,
"updated": 0,
"updated_by": 0,
"value": "string"
}

List labels assigned to pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.
page	integer >= 1 Default: 1 The page to return.
limit	integer [ 1 .. 100 ] Default: 30 The maximum number of results to return.
assignable	boolean Default: false The result should contain all labels assignable to the pullreq.
query	string The substring which is used to filter the labels by their key.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels

Request samples

curl
Java
Go

Response samples

application/json

{"label_data": [{"assigned": true,
"assigned_value": {"color": "string",
"id": 0,
"value": "string"
},
"color": "blue",
"id": 0,
"key": "string",
"scope": 0,
"type": "dynamic",
"values": [{"color": "string",
"id": 0,
"value": "string"
}
]
}
],
"scope_data": [{"repository": {"created": 0,
"created_by": 0,
"default_branch": "string",
"deleted": 0,
"description": "string",
"fork_id": 0,
"git_ssh_url": "string",
"git_url": "string",
"id": 0,
"identifier": "string",
"is_empty": true,
"num_closed_pulls": 0,
"num_forks": 0,
"num_merged_pulls": 0,
"num_open_pulls": 0,
"num_pulls": 0,
"parent_id": 0,
"path": "string",
"size": 0,
"size_updated": 0,
"state": 0,
"updated": 0
},
"scope": 0,
"space": {"created": 0,
"created_by": 0,
"deleted": 0,
"description": "string",
"id": 0,
"identifier": "string",
"parent_id": 0,
"path": "string",
"updated": 0
}
}
]
}

Assign label to pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer

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

label_id	integer
value	string
value_id	integer or null

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

put/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels

Request samples

Payload
curl
Java
Go

application/json

{"label_id": 0,
"value": "string",
"value_id": 0
}

Response samples

application/json

{"created": 0,
"created_by": 0,
"label_id": 0,
"pullreq_id": 0,
"updated": 0,
"updated_by": 0,
"value_id": 0
}

Unassign label from pull request

Securityx-api-key

Request

path Parameters

repo_identifier required	string
pullreq_number required	integer
label_id required	integer

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

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels/{label_id}

Request samples

curl
Java
Go

Response samples

application/json

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

➔ Next to usage