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

# Repo: Update

> Change the default branch of the repository identified by the JWT `repo` claim.

The gateway reads the current `HEAD` symbolic ref, then repoints it at the requested branch through a transactional compare-and-swap against that value, and finally records the new default branch in the repository row. Branch names are fully qualified for you: `main` is written as the symref target `refs/heads/main`, and a value that already starts with `refs/` is used verbatim. The branch itself is not created by this call.
#### JWT claims
Required scopes: `repo:write`  
Requires per repo scope: Yes



## OpenAPI

````yaml openapi.json PATCH /api/repos/{repo_name}
openapi: 3.1.0
info:
  description: >-
    The Code Storage HTTP API exposes repository management, Git reads, and
    write workflows over plain HTTPS.


    ## Authentication


    Send a signed JWT in the `Authorization: Bearer <token>` header on every
    request.


    - Organisation-scoped endpoints such as `GET /api/repos` require
    organisation scopes like `org:read`

    - Repository-scoped endpoints require a JWT whose `repo` claim names the
    target repository

    - Write operations require the relevant scope such as `git:write` or
    `repo:write`


    ## Pagination


    List endpoints use cursor-based pagination.


    - `cursor` is an opaque token returned by the previous response

    - `limit` defaults to `20` and is capped per endpoint

    - `has_more` tells you whether another request is available

    - `next_cursor` becomes the next `cursor` value


    ## Paths


    Preferred routes use the shorter `/api/...` form. Legacy `/api/v1/...`
    aliases remain documented where they are still supported and are marked as
    deprecated when a preferred route exists.


    ## Repository names in paths


    - Names containing `/` (or any other character that is not safe in a URL
    path segment) **must** be URL encoded so the value occupies a single path
    segment. For example, `pierre/example` becomes `pierre%2Fexample` and the
    request URL is `/api/repos/pierre%2Fexample/...`.

    - Plain names that contain only URL-safe characters can be sent as-is:
    `/api/repos/dotfiles/...`.

    - The server URL-decodes the value before resolving the repository, so
    double-encoding is not required.


    ## Errors


    Most endpoints return RFC 9457-compatible problem details under
    `application/problem+json`, with a legacy `error` field mirrored from
    `detail`. Each problem body has a stable, snake_case `code`. Branch on
    `code`, not on `detail`. The Error codes section lists the values.


    A `429 Too Many Requests` response carries the current IETF `RateLimit`
    service-limit field and `Retry-After`. `RateLimit` reports immediately
    available quota (`r`) and its effective window in seconds (`t`);
    `Retry-After` is the minimum delay and takes precedence. The gateway's
    capacity is dynamic, so it does not advertise a fixed `RateLimit-Policy` on
    successful responses.


    Streaming commit and note workflows may return operation-specific failure
    bodies so callers can inspect partial results, branch state, or workflow
    status without parsing generic error strings.


    ## Error codes


    Each problem body has a stable `code`. Each status has a generic code. A
    specific code replaces it when the caller must take a different action. New
    codes can be added. Treat an unknown code as the generic code for its
    status.


    Generic codes: `bad_request` (400), `unauthorized` (401), `forbidden` (403),
    `not_found` (404), `method_not_allowed` (405), `request_timeout` (408),
    `conflict` (409), `precondition_failed` (412), `payload_too_large` (413),
    `unprocessable_entity` (422), `rate_limited` (429), `request_canceled`
    (499), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502),
    `service_unavailable` (503), `gateway_timeout` (504). Any other status uses
    its status text in snake_case.


    Specific codes:


    - `authentication_unavailable` (403): the server cannot verify credentials
    now; retry.

    - `insufficient_scope` (403): the token does not have a scope that the
    operation requires.

    - `repo_claim_missing` (400): the token has no `repo` claim.

    - `repo_name_mismatch` (400): the request `repo_name` does not match the
    token `repo` claim.

    - `route_not_found` (404): no API route matches the path.

    - `repository_not_found` (404): the repository does not exist or the token
    cannot access it.

    - `repository_deleted` (409): the repository is already deleted.

    - `repository_thawing` (409): the repository is being restored from cold
    storage; retry after `Retry-After`.

    - `sync_in_progress` (409): an upstream sync is in progress; retry.

    - `upstream_already_configured` (409): the repository already has an
    upstream.

    - `branch_not_found` (404): the branch does not exist.

    - `ref_not_found` (404): the ref or revision does not exist.

    - `merge_conflict` (409): the merge has file conflicts.

    - `credential_not_found` (404): the Git credential does not exist.

    - `credential_exists` (409): the repository already has a Git credential.

    - `github_app_not_configured` (412): the organization does not have exactly
    one GitHub App.

    - `github_repository_inaccessible` (412, or the 4xx status from the
    upstream): GitHub does not give access to the upstream repository.

    - `hosting_not_enabled` (403): hosting is not enabled for the organization.

    - `hosting_project_not_found` (404): the repository has no hosting project.

    - `deployment_not_found` (404): the deployment does not exist.

    - `deployment_project_name_in_use` (409): another repository uses the
    hosting project name.

    - `idempotency_key_reused` (422): the idempotency key belongs to a different
    request.
  title: code.storage
  version: 1.0.0
servers:
  - description: Code Storage API host for your organization
    url: https://api.{org}.code.storage
    variables:
      org:
        default: your-org
        description: >-
          The subdomain of your API host. It is usually your organization name.
          The organization settings page in the dashboard shows your exact API
          host.
security: []
tags:
  - description: >-
      Create, inspect, update, delete, and synchronise repositories, including
      upstream pull-sync and generic HTTPS Git credentials for non-GitHub
      upstreams.
    name: Repositories
  - description: Create, delete, list, and compare branches.
    name: Branches
  - description: >-
      Read commit metadata and diffs, or create commits without a local Git
      client.
    name: Commits
  - description: >-
      Read repository trees, file contents, archives, and server-side search
      results.
    name: Files
  - description: List, create, and delete Git tags.
    name: Tags
  - description: Attach and retrieve Git notes for commits or other Git objects.
    name: Notes
  - description: >-
      Read metadata about the Code Storage deployment that serves your
      organisation, such as its cloud location and inbound IP addresses.
    name: Organization
paths:
  /api/repos/{repo_name}:
    patch:
      tags:
        - Repositories
      summary: Update Repository Settings
      description: >-
        Change the default branch of the repository identified by the JWT `repo`
        claim.


        The gateway reads the current `HEAD` symbolic ref, then repoints it at
        the requested branch through a transactional compare-and-swap against
        that value, and finally records the new default branch in the repository
        row. Branch names are fully qualified for you: `main` is written as the
        symref target `refs/heads/main`, and a value that already starts with
        `refs/` is used verbatim. The branch itself is not created by this call.

        #### JWT claims

        Required scopes: `repo:write`  

        Requires per repo scope: Yes
      operationId: repos-update
      parameters:
        - description: >-
            Repository name. Names that contain `/` or any other character that
            is not safe in a URL path segment must be URL encoded so the value
            occupies a single path segment. For example `pierre/example` is sent
            as `pierre%2Fexample`. Plain names such as `example` can be sent
            as-is. The server URL-decodes the value before resolving the
            repository.
          example: my-demo-repository
          in: path
          name: repo_name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              default_branch: main
            schema:
              $ref: '#/components/schemas/ReposUpdateRequest'
        description: >-
          Repository settings to change. `default_branch` is the only supported
          field and must be a non-empty branch name.
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                default_branch: main
                id: repo_7f2b3d9
                repo_id: repo_7f2b3d9
                repo_name: pierre/sdk-documentation
                url: pierre/sdk-documentation
              schema:
                $ref: '#/components/schemas/ReposUpdateResponse'
          description: >-
            Default branch updated. Returns the repository ID, its URL path, and
            the branch name now recorded as the default.
        '400':
          content:
            application/json:
              example:
                code: bad_request
                detail: default_branch is required
                error: default_branch is required
                instance: /api/repos/my-demo-repository
                status: 400
                title: Bad Request
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              example:
                code: bad_request
                detail: default_branch is required
                error: default_branch is required
                instance: /api/repos/my-demo-repository
                status: 400
                title: Bad Request
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The body could not be decoded as JSON, or `default_branch` was
            missing or empty.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            No repository matching the JWT `repo` claim exists for this
            organisation.
        '409':
          content:
            application/json:
              example:
                code: conflict
                detail: default branch was modified concurrently, please retry
                error: default branch was modified concurrently, please retry
                instance: /api/repos/my-demo-repository
                status: 409
                title: Conflict
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              example:
                code: conflict
                detail: default branch was modified concurrently, please retry
                error: default branch was modified concurrently, please retry
                instance: /api/repos/my-demo-repository
                status: 409
                title: Conflict
                type: about:blank
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            `HEAD` moved between the read and the compare-and-swap, so the
            update was rejected. Retry the request.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Too Many Requests
          headers:
            RateLimit:
              description: >-
                Current IETF service-limit field. `r=0` means no request is
                immediately available; `t` is the effective window in seconds
                before capacity is expected to return.
              schema:
                type: string
            Retry-After:
              description: >-
                Minimum delay before retrying, expressed as seconds or an HTTP
                date. This value takes precedence over the `RateLimit` effective
                window.
              schema:
                type: string
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          description: >-
            The current `HEAD` value could not be read from storage, so no
            compare-and-swap was attempted and nothing was changed.
      security:
        - bearerAuth:
            - repo:write
components:
  schemas:
    ReposUpdateRequest:
      additionalProperties: false
      description: Repository settings to patch, such as the default branch.
      properties:
        default_branch:
          description: New default branch name for the Code Storage repository.
          examples:
            - main
          type: string
      type: object
    ReposUpdateResponse:
      additionalProperties: false
      description: Repository state after applying the patch.
      properties:
        default_branch:
          description: Updated default branch name.
          examples:
            - main
          type: string
        id:
          deprecated: true
          description: 'Deprecated: use repo_name. Stable repository identifier.'
          examples:
            - repo_7f2b3d9
          type: string
        repo_id:
          deprecated: true
          description: 'Deprecated: use repo_name. Stable repository identifier.'
          examples:
            - repo_7f2b3d9
          type: string
        repo_name:
          description: >-
            Repository name or path. It can contain a slash. It matches the JWT
            repo claim.
          examples:
            - pierre/sdk-documentation
          type: string
        url:
          deprecated: true
          description: 'Deprecated: use repo_name. Repository name or path, not a full URL.'
          examples:
            - pierre/sdk-documentation
          type: string
      required:
        - repo_id
        - id
        - repo_name
        - url
        - default_branch
      type: object
    ProblemDetails:
      additionalProperties: false
      description: >-
        RFC 9457-compatible problem details payload describing the error
        response.
      properties:
        code:
          description: >-
            A stable, machine-readable error code in snake_case. Branch on
            `code`, not on `detail`. The API description lists the codes.
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        error:
          description: Legacy compatibility field mirroring `detail` for older clients.
          type: string
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          type: string
        status:
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem.
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        type:
          description: >-
            A URI reference that identifies the problem type. `about:blank`
            indicates the generic HTTP status semantics apply.
          type: string
      required:
        - type
        - title
        - status
        - code
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: >-
        JWT bearer token signed with your organization's registered signing key.
        There is no OAuth authorization server; you mint tokens yourself and the
        token's `scopes` claim carries the granted permission scopes. Public
        scopes: `git:read` (read repository contents), `git:write` (write
        branches, commits, tags, and notes), `repo:write` (create and manage
        repositories), `org:read` (list an organization's repositories). Each
        operation's security requirement names the scopes it requires. See
        https://code.storage/docs/getting-started/authentication for how to mint
        tokens.
      scheme: bearer
      type: http

````