openapi: 3.1.0
info:
  title: imgix Management API
  description: |
    imgix Management API for administering sources, purges, asset manager,
    and reporting. Requests use the JSON:API content type
    `application/vnd.api+json`.
  version: "1.0"
  contact:
    name: imgix Support
    url: https://docs.imgix.com/en-US/apis/management/overview
servers:
  - url: https://api.imgix.com
    description: Production
security:
  - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer API key from the imgix dashboard.
paths:
  /api/v1/sources:
    get:
      summary: List sources
      operationId: listSources
      responses:
        "200":
          description: A list of sources
    post:
      summary: Create a source
      operationId: createSource
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
      responses:
        "201":
          description: Source created
  /api/v1/sources/{source_id}:
    parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
    get:
      summary: Retrieve a source
      operationId: getSource
      responses:
        "200":
          description: Source details
    patch:
      summary: Update a source
      operationId: updateSource
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
      responses:
        "200":
          description: Source updated
  /api/v1/sources/{source_id}/purge:
    parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
    post:
      summary: Purge a URL from the imgix cache
      operationId: purgeAsset
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      example: purges
                    attributes:
                      type: object
                      properties:
                        url:
                          type: string
                          format: uri
      responses:
        "200":
          description: Purge accepted
  /api/v1/sources/{source_id}/assets:
    parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
    get:
      summary: List assets for a source
      operationId: listAssets
      responses:
        "200":
          description: A list of assets