---
title: "Reserve an attachment upload"
method: POST
path: "/api/repos/{owner}/{repo}/attachments/"
tags: ["Attachments"]
---

# Reserve an attachment upload

`POST /api/repos/{owner}/{repo}/attachments/`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/attachments/`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:attachments:write`

Creates an idempotent upload reservation for the declared SHA-256 digest and byte count, capped at 10 MiB. Requires authenticated authority and enforces current resource policy.

## Path parameters

- `owner` string, required
- `repo` string, required

## Request body

- object
  - `requestKey` string, required
  - `sha256` string, required
  - `size` integer, required

## Response `201`

Response for status 201

- object
  - `id` string, required
  - `state` 'reserved' | 'writing' | 'ready' | 'deleting' | 'deleted' | 'rejected', required
  - `size` integer, required
  - `contentType` 'image/png' | 'image/jpeg' | 'image/gif' | 'image/webp' | 'null', nullable, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)