Skip to main content
POST
CSharp (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

session_id
string
required

Body

application/json

Public operation request.

It deliberately has no credential or repository field: the credential is the caller's stored connection, and the repository is the session's clone binding. checkout_path names where the repository root sits inside the workspace (empty = the workspace root), because the caller — the agent working in the checkout — knows the layout and the server must not guess it.

assignment_generation
integer
required
Required range: x >= 1
branch
string
required
Required string length: 1 - 255
checkout_path
string
default:""
Maximum string length: 512
force
boolean
default:false

Response

Successful Response

session_id
string
required
assignment_generation
integer
required
repository_id
integer
required
owner
string
required
repository
string
required
branch
string
required
remote_head_sha
string
required
no_changes
boolean
required