Skip to main content

Checkout a git repository

POST 
/source-svc/repo/checkout

Checkout a git repository over https or ssh at a specific version into a temporary directory. Performs a shallow clone with minimal history for faster checkout.

Request​

Body

required

Checkout Repo Request

    password string

    Password or token for HTTPS auth

    ssh_key string

    SSH private key (optional for SSH connection)

    ssh_key_pwd string

    Password for SSH private key if encrypted (optional)

    token string

    Token for HTTPS auth (optional for SSH)

    url string

    Full repository URL (e.g., https://github.com/user/repo)

    username string

    Username for HTTPS or SSH user (optional for SSH)

    version string

    Branch, tag, or commit SHA

Responses​

Successfully checked out the repository

Schema

    dir string

    Directory where the repository was checked out

Loading...