SwaggerHub Settings API

openapi: 3.0.1
info:
  title: SwaggerHub Registry APIs Settings API
  description: 'The SwaggerHub Registry API provides programmatic access to all SwaggerHub resources: APIs, domains, integrations, projects, templates, and standardization rulesets. Use it to manage API versions, publish APIs, run CI/CD integrations, manage projects, and retrieve OpenAPI definitions.'
  version: 1.3.0
  contact:
    name: SmartBear SwaggerHub Support
    url: https://support.smartbear.com/swaggerhub/
  license:
    name: SmartBear License
    url: https://swagger.io/license/
  x-logo:
    url: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
servers:
- url: https://api.swaggerhub.com
  description: SwaggerHub Registry API
security:
- ApiKeyAuth: []
tags:
- name: Settings
  description: API lifecycle and visibility settings
paths:
  /apis/{owner}/{api}/{version}/settings/lifecycle:
    get:
      operationId: getLifecycleSettings
      summary: Get Lifecycle Settings
      description: Get the publish/unpublish status of an API version.
      tags:
      - Settings
      parameters:
      - name: owner
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Lifecycle settings
    put:
      operationId: updateLifecycleSettings
      summary: Update Lifecycle Settings
      description: Publish or unpublish an API version.
      tags:
      - Settings
      parameters:
      - name: owner
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                published:
                  type: boolean
      responses:
        '200':
          description: Settings updated
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: SwaggerHub API key. Obtain from My Account > API Key in SwaggerHub. Pass the key as the Authorization header value without any prefix.