Skip to main content
PUT
Update project agent label

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project UUID or slug.

Example:

"my-project"

agent_id
string
required
Minimum string length: 1
label_id
string<uuid>
required

Label UUID within the selected resource.

Query Parameters

source_target_kind
enum<string>
default:project
Available options:
project,
main_branch,
preview_branch
target_branch_id
string<uuid> | null

Body

application/json
key
string
required

Required label key. Trimmed and lowercased; starts with a letter or number and allows letters, numbers, dot, underscore and dash.

Required string length: 1 - 64
value
string | null

Label value. Trimmed; a supplied blank value is invalid. Omit or use null for a key-only label, including on replacement.

Maximum string length: 128
color
string | null

Display color. Omit, use null or supply a blank string to clear it, including on replacement.

Maximum string length: 32

Response

Updated label.

id
string<uuid>
required

Label UUID.

resource_kind
enum<string>
required

Resource to which the label is assigned.

Available options:
project,
project_agent
project_id
string<uuid>
required

Project UUID containing the labeled resource.

namespace
string
required

Normalized label namespace. API-created labels use user.

key
string
required

Normalized lowercase label key.

value
string | null
required

Trimmed label value, or null for a key-only label.

created_at
string
required

Creation time as an ISO 8601 timestamp.

updated_at
string
required

Last update time as an ISO 8601 timestamp.

source_target_kind
string | null
source_agent_id
string | null
color
string | null

Trimmed display color, or null when unset.