Codefresh Segment 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 Segment 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: Segment
paths:
  /admin/accounts/{accountId}/segment/{segmentType}:
    post:
      x-sdk-interface: accounts.setSegment
      x-action: setSegment
      x-entityId:
        pathName: params.segmentType
      operationId: accounts-set-segment
      tags:
      - Segment
      parameters:
      - description: accountId of an object
        in: path
        name: accountId
        required: true
        schema:
          type: string
      - description: Type of segment
        in: path
        name: segmentType
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                trial:
                  type: object
                  properties:
                    trialing:
                      type: boolean
                    trialWillEndNotified:
                      type: boolean
                    trialEndedNotified:
                      type: boolean
                    type:
                      type: string
                    previousSegment:
                      type: string
                    trialEnd:
                      type: string
                    trialStart:
                      type: string
      summary: Set account segment
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"trial\\\":{\\\"trialing\\\":${TRIALING_BOOL},\\\"trialWillEndNotified\\\":${TRIAL_WILL_END_NOTIFIED_BOOL},\\\"trialEndedNotified\\\":${TRIAL_ENDED_NOTIFIED_BOOL},\\\"type\\\":\\\"${TYPE_STR}\\\",\\\"previousSegment\\\":\\\"${PREVIOUS_SEGMENT_STR}\\\",\\\"trialEnd\\\":\\\"${TRIAL_END_STR}\\\",\\\"trialStart\\\":\\\"${TRIAL_START_STR}\\\"}}\" \\\n    \"https://g.codefresh.io/api/admin/accounts/${ACCOUNT_ID}/segment/${SEGMENT_TYPE}\""
      - lang: node.js
        source: "sdk.accounts.setSegment({ accountId, segmentType }, {\n    trial: {\n        trialing: TRIALING_BOOL,\n        trialWillEndNotified: TRIAL_WILL_END_NOTIFIED_BOOL,\n        trialEndedNotified: TRIAL_ENDED_NOTIFIED_BOOL,\n        type: `${TYPE_STR}`,\n        previousSegment: `${PREVIOUS_SEGMENT_STR}`,\n        trialEnd: `${TRIAL_END_STR}`,\n        trialStart: `${TRIAL_START_STR}`\n    }\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-segment-api-openapi.yml