---
title: "POST /api/v1/artifacts/image_repositories/{id}/contract"
method: POST
path: "/api/v1/artifacts/image_repositories/{id}/contract"
tags: ["artifacts"]
---

# POST /api/v1/artifacts/image_repositories/{id}/contract

`POST /api/v1/artifacts/image_repositories/{id}/contract`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/artifacts/image_repositories/{id}/contract`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- ImageRepositoryContractPayload
  - `operation` 'push' | 'pull', required
  - `reference` string, required
  - `ttl_seconds` integer

## Response `200`

Image repository push or pull contract

- ImageRepositoryContractResponse
  - `image_repository` ImageRepository, required
    - `id` string, required
    - `organization_id` string, required
    - `hosted_app_id` string, nullable, required
    - `slug` string, required
    - `name` string, required
    - `provider_kind` 'oci' | 'docker_registry', required
    - `repository_path` string, required
    - `visibility` 'private' | 'internal' | 'public', required
    - `status` 'active' | 'paused' | 'archived', required
    - `auth_configured` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required
  - `contract` ImageRepositoryContract, required
    - `provider` string, required
    - `operation` 'push' | 'pull', required
    - `repository_path` string, required
    - `reference` string, required
    - `push_registry_host` string
    - `pull_registry_host` string
    - `push_image_reference` string
    - `pull_image_reference` string
    - `image_reference` string
    - `auth` ImageRepositoryContractAuth
      - `username` string, required
      - `required` boolean, required
      - `token_hint` string, nullable
      - `login_command` string, nullable
      - `token_realm` string, nullable
      - `service` string, nullable
      - `scope` string, nullable
    - `expires_in_seconds` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)