Codefresh Download API

openapi: 3.2.0
info:
  contact:
    name: Codefresh
    url: https://www.codefresh.io
  description: Codefresh API openAPI 3.0 specification
  termsOfService: https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/
  title: Codefresh Download API
  version: 0.0.2
  x-logo:
    url: https://g.codefresh.io/modules/cf.resources/codefresh-api-docs-images/codefresh-logo-api.svg
    backgroundColor: '#FFFFFF'
    altText: Codefresh
servers:
- url: https://g.codefresh.io/api
security:
- API-key: []
tags:
- name: Download
paths:
  /audit/download:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Download
      operationId: audit-download
      parameters:
      - name: userName
        in: query
        schema:
          type: string
        description: filter by user name
      - name: userId
        in: query
        schema:
          type: string
        description: filter by codefresh user id
      - name: entity
        in: query
        schema:
          type: string
        description: 'filter by api entity, example: pipeline, account'
      - name: entityId
        in: query
        schema:
          type: string
        description: 'filter by api entity id, this value different for each action, example: email, user id'
      - name: action
        in: query
        schema:
          type: string
        description: filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account
      - name: rs_status
        in: query
        schema:
          type: integer
        description: filter by response status code
      - name: showTriggers
        in: query
        schema:
          type: string
        description: returns only actions related to receiving triggers
      - name: search
        in: query
        schema:
          type: string
        description: filter by searching substring in request body or query or params or headers or url
      - name: from
        in: query
        schema:
          type: integer
        description: filter by date, value is number of milliseconds since 1970
      - name: to
        in: query
        schema:
          type: integer
        description: filter by date, value is number of milliseconds since 1970
      - name: sortField
        in: query
        schema:
          type: string
        description: 'name of sorting field, values: id, createdAt, updatedAt'
      - name: sortType
        in: query
        schema:
          type: string
        description: 'sorting type, values: ASK, DESK'
      - name: pageSize
        in: query
        schema:
          type: string
        description: Size of the audit page for download. The server will download 5 pages with used page size. The default limit of page size is 10000 and max limit is 10000. By default the server will get 50000 audit records.
      summary: Download
      x-sdk-interface: audit.download
      x-endpoint:
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: audit.download
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/audit/download?userName=${USER_NAME}&userId=${USER_ID}&entity=${ENTITY}&entityId=${ENTITY_ID}&action=${ACTION}&rs_status=${RS_STATUS}&showTriggers=${SHOW_TRIGGERS}&search=${SEARCH}&from=${FROM}&to=${TO}&sortField=${SORT_FIELD}&sortType=${SORT_TYPE}&pageSize=${PAGE_SIZE}\""
      - lang: node.js
        source: "sdk.audit.download({\n    userName,\n    userId,\n    entity,\n    entityId,\n    action,\n    rs_status,\n    showTriggers,\n    search,\n    from,\n    to,\n    sortField,\n    sortType,\n    pageSize\n})"
components:
  securitySchemes:
    API-key:
      in: header
      name: Authorization
      description: 'An api key got from: User Settings -> API keys -> Generate'
      type: apiKey
x-service-name: api-public
x-base-path: /api
x-internal-services:
- pipeline-manager
- api
x-endpoint-conditions:
- weight: 0
  condition: global.has-general-service-role
  handlerRegex: (.*)
- weight: 1
  condition: global.has-kubernetes-endpoints-service-role
  handlerRegex: kubernetes\.\w+
- weight: 2
  condition: global.has-auth-service-role
  handlerRegex: api-key\.\w+
x-tagGroups:
- name: Pipelines / Builds
  tags:
  - Annotations
  - Builds
  - Execution Contexts
  - Images
  - Pipelines
  - Progress
  - Projects
  - Step-types
  - Triggers
  - Triggers Events
  - Triggers Types
- name: Kubernetes / Helm
  tags:
  - Environments V2
  - Helm Boards
  - Helm Charts
  - Helm Releases
  - Helm Sections
  - Kubernetes
- name: Swarm
  tags:
  - Compositions
  - Environments
- name: Integrations / Contexts
  tags:
  - Clusters
  - Contexts
  - Helm Cluster Configs
  - Helm Repos
  - Registries
  - Repos
- name: Account Management
  tags:
  - Abac
  - Accounts
  - Agents
  - Audit
  - Runtime Environments
  - Teams
  - Tokens
  - Views
- name: User Properties
  tags:
  - favorites
- name: On-Premise
  tags:
  - Features
  - Runtime Environments (Account)
  - Runtime Environments (Plan)
  - Runtime Environments (System)
  - Runtime Environments.
- name: Platform Analytics
  tags:


# --- truncated at 32 KB (130 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-download-api-openapi.yml