Cloudsmithio API

openapi: 3.1.0
info:
  title: Cloudsmithio API
  version: '2026-10-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-09: 5 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Cloudsmithio has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.cloudsmith.com/api
  - https://docs.cloudsmith.com/api/rate-limits
  - https://docs.cloudsmith.com/api/metadata/validate/create
servers:
- url: https://api.cloudsmith.io
paths:
  /metadata/validate:
    post:
      operationId: post_metadata_validate
      tags:
      - Metadata
      summary: Validate a metadata payload
      x-source: https://docs.cloudsmith.com/api/metadata/validate/create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMetadataValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMetadataValidateResponse'
      x-evidence:
        kind: documentation
  /package/example/repo/packages/:
    get:
      operationId: get_package_example_repo_packages
      tags:
      - Package
      summary: List packages in the specified repository with pagination support.
      x-source: https://docs.cloudsmith.com/api
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: The current page of the pagination dataset to view (1‑based).
      - name: page_size
        in: query
        required: false
        schema:
          type: string
        description: Number of items per page (default 30, max 500).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user/self:
    get:
      operationId: get_user_self
      tags:
      - User
      summary: GET /user/self
      x-source: https://docs.cloudsmith.com/api/rate-limits
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserSelfResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"x-api-key: csa_NOPE\" -i http://api.cloudsmith.io/user/self/ -L --verbose 2>&1 | grep -i x-rate \n < x-ratelimit-interval:\
          \ 0 \n < x-ratelimit-limit: 50000 \n < x-ratelimit-remaining: 49999 \n < x-ratelimit-reset: 1786544720 \n x-ratelimit-interval: 0 \n\
          \ x-ratelimit-limit: 50000 \n x-ratelimit-remaining: 49999 \n x-ratelimit-reset: 1786544720 \n For unauthorized requests: \n bash $\
          \ curl -i http://api"
    options:
      operationId: options_user_self
      tags:
      - User
      summary: OPTIONS /user/self
      x-source: https://docs.cloudsmith.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Authorization: token $key \" https://api.cloudsmith.io/user/self/ \n Specifying an invalid API Key will result in\
          \ an 401 Unauthorized status code, and the body will specify that an invalid token was received. Let's see it in action: \n bash curl\
          \ -i -H \"Authorization: token foobar\" -X OPTIONS https://api.cloudsmith.io/user/self/ \n HTTP/2 401 \n date: Thu, 09 Mar 2023 16:55:35\
          \ GMT \n server: Clo"
  /user/self/:
    get:
      operationId: get_user_self
      tags:
      - User
      summary: Retrieve the authenticated user's own profile information.
      x-source: https://docs.cloudsmith.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostMetadataValidateRequest:
      type: object
      properties:
        content:
          type: object
          description: The metadata payload as a JSON object.
        content_type:
          type: string
          description: The content type describing the structure of the metadata payload.
      required:
      - content
      - content_type
    PostMetadataValidateResponse:
      type: object
      properties:
        '200':
          type: string
          description: The payload is valid for the given content type.
        '401':
          type: string
          description: Authentication credentials were not provided or are invalid.
        '422':
          type: string
          description: The request body failed validation.
    GetUserSelfResponse:
      type: object
      properties:
        detail:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
security:
- apiKey: []
tags:
- name: Metadata
- name: Package
- name: User