Naar navigatie springen

Agentbranch bijwerken

Werk eigenschappen van de agentbranch bij, zoals naam, beschrijving, archiveringsstatus, beschermingsniveau en automatisch rebasen op main

Padparameters

agent_idstringVerplicht
De id van een agent. Deze wordt teruggegeven wanneer de agent wordt gemaakt.
branch_idstringVerplicht
Unieke identificatiecode voor de branch.

Headers

xi-api-keystringOptioneel

Verzoek

This endpoint expects an object.
namestringOptioneel1-140 characters
Nieuwe naam voor de branch. Moet uniek zijn binnen de agent.
descriptionstringOptioneel<=4096 characters
Nieuwe beschrijving voor de branch. Geef een lege tekenreeks door om deze te wissen.
is_archivedbooleanOptioneel
Of de branch moet worden gearchiveerd
protection_statusenumOptioneelStandaard writer_perms_required
Het beschermingsniveau voor de branch
Toegestane waarden:
auto_rebasebooleanOptioneel

Wanneer true, rebase je deze branch automatisch op main na elke nieuwe main-versie. Kan niet worden ingeschakeld op de main-branch.

Response

Geslaagde response
idstring
namestring
agent_idstring
descriptionstring
created_atinteger
last_committed_atinteger
is_archivedboolean
protection_statusenumOptioneelStandaard writer_perms_required
Toegestane waarden:
auto_rebasebooleanOptioneelStandaard false
access_infoobjectOptioneel
Toegangsinformatie voor de branch
current_live_percentagedoubleOptioneelStandaard 0
Percentage van het verkeer dat live is op de branch
parent_branchobjectOptioneel
Bovenliggende branch van de branch
most_recent_versionslist of objectsOptioneel
Meest recente versies op de branch

Fouten

422
Branches Update Request Unprocessable Entity Error