List agent branches

Returns a list of branches an agent has

Parámetros de ruta

agent_idstringRequerido
The id of an agent. This is returned on agent creation.

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

include_archivedbooleanOpcionalValor predeterminado: false
Whether archived branches should be included
limitintegerOpcional<=100Valor predeterminado: 100
How many results at most should be returned
include_commit_statusbooleanOpcionalValor predeterminado: false

Whether to compute how far each branch has diverged from main (commits_ahead/commits_behind). This walks the version DAG of every branch, so it is slow on agents with long histories and is off by default, leaving those fields null.

Respuesta

Successful Response
resultslist of objects
metaobjectOpcional

Errores

422
Branches List Request Unprocessable Entity Error