> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# checkout (Surround)

> Checkout repository in writable state. Use this operation in conjunction with checkin to make changes to files. Target Properties Property Name Proper

Checkout repository in writable state. Use this operation in conjunction with checkin to make changes to files.

# Target Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Surround Executable</td><td>`FDSURROUND_EXE_PATH`</td><td>N</td><td>Path to the Surround executable. Required only if Surround is not on PATH.</td></tr></tbody></table>

# Inputs

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Input Name**</th><th>**Input Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Surround Instance</td><td>`FDSURROUND_INP_INSTANCE_CODE`</td><td>Y</td><td>The Surround Instance to use.</td></tr><tr><td>Branch</td><td>`FDSURROUND_INP_BRANCH`</td><td>Y</td><td>The branch to get from.</td></tr><tr><td>Folder</td><td>`FDSURROUND_INP_FOLDER`</td><td>Y</td><td>The folder in Surround to get from.</td></tr><tr><td>Destination Sub Directory</td><td>`FDSURROUND_INP_DESTINATION_SUBDIRECTORY`</td><td>N</td><td>The sub directory under the temp directory to place the files.</td></tr><tr><td>Exclusive checkout</td><td>`FDSURROUND_INP_EXCLUSIVE_CHECKOUT`</td><td>N</td><td>Lock the files when checking them out.</td></tr></tbody></table>

# Artifacts

This operation doesn’t consume or produce any artifacts.

# Endpoint Selection

This operation will select all available endpoints associated to the Target.

# Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

# Special Considerations

Make sure to checkin the files after checking them out, otherwise the files will stay checked out.
