Chef Software ConfigMgmt API

swagger: '2.0'
info:
  title: external/applications/applications.proto ApplicationsService ConfigMgmt API
  version: version not set
consumes:
- application/json
produces:
- application/json
tags:
- name: ConfigMgmt
paths:
  /api/beta/cfgmgmt/rollouts/create:
    post:
      summary: CreateRollout
      description: 'Creates a Rollout record. A rollout represents the process of nodes acquiring

        the latest policy revision pushed to a policy group.


        Authorization Action:

        ```

        ingest:unifiedEvents:create

        ```'
      operationId: ConfigMgmt_CreateRollout
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Rollout'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.request.CreateRollout'
      tags:
      - ConfigMgmt
  /api/beta/cfgmgmt/rollouts/find:
    get:
      summary: GetRolloutForChefRun
      description: 'Returns the rollout for the given Chef Server/org, policy group, policy name, and policy revision


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetRolloutForChefRun
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Rollout'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: policy_name
        in: query
        required: false
        type: string
      - name: policy_group
        in: query
        required: false
        type: string
      - name: policy_revision_id
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/beta/cfgmgmt/rollouts/list:
    get:
      summary: GetRollouts
      description: 'Gives a list of rollouts


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetRollouts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Rollouts'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: Filters to apply to the request for the rollouts list.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      tags:
      - ConfigMgmt
  /api/beta/cfgmgmt/rollouts/progress_by_node_segment:
    get:
      operationId: ConfigMgmt_ListNodeSegmentsWithRolloutProgress
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodeSegmentsWithRolloutProgress'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: Filters to apply to the request for the node segments list.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      tags:
      - ConfigMgmt
  /api/beta/cfgmgmt/rollouts/rollout/{rollout_id}:
    get:
      summary: GetRolloutById
      description: 'Returns the rollout with the given Id


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetRolloutById
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Rollout'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: rollout_id
        in: path
        required: true
        type: string
      tags:
      - ConfigMgmt
  /api/beta/cfgmgmt/rollouts/test_create:
    post:
      summary: CreateRolloutTest
      description: 'CreateRolloutTest is a no-op endpoint that has the same auth requirements as

        CreateRollout. It can be used to verify end-to-end config/connectivity for

        clients


        Authorization Action:

        ```

        ingest:unifiedEvents:create

        ```'
      operationId: ConfigMgmt_CreateRolloutTest
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.CreateRolloutTest'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.request.CreateRolloutTest'
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/errors:
    get:
      summary: List Errors
      description: 'Returns a list of the most common errors reported for infra nodes'' most recent Chef Infra Client runs.


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetErrors
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Errors'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: size
        description: 'The number of results to return.

          If set to zero, the default size of 10 will be used. Set to a negative

          value for unlimited results.'
        in: query
        required: false
        type: integer
        format: int32
      - name: filter
        description: 'Filters in the request select the nodes from which the errors are

          collected. The same filters may be specified for this request as for other

          Nodes requests, with the exception of ''status'' which is not valid for this

          request.'
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/node_metadata_counts:
    get:
      summary: GetNodeMetadataCounts
      description: "For each type of field requested this returns distinct values the amount of each. For example, \nif the 'platform' field is requested 'windows' 10, 'redhat' 5, and 'ubuntu' 8 could be returned. \nThe number next to each represents the number of nodes with that type of platform.\n\nExample:\nrequest\n```\ncfgmgmt/node_metadata_counts?type=platform&type=status\n```\nresponse\n```\n{\n\"types\": [\n{\n\"values\": [\n{\n\"value\": \"mac_os_x 10.11.5\",\n\"count\": 28\n},\n{\n\"value\": \"linux 8.9\",\n\"count\": 1\n},\n{\n\"value\": \"macos 8.9\",\n\"count\": 1\n},\n{\n\"value\": \"windows 8.9\",\n\"count\": 1\n}\n],\n\"type\": \"platform\"\n},\n{\n\"value\": [\n{\n\"value\": \"missing\",\n\"count\": 29\n},\n{\n\"value\": \"failure\",\n\"count\": 2\n}\n],\n\"type\": \"status\"\n}\n]\n}\n```\n\nAuthorization Action:\n```\ninfra:nodes:list\n```"
      operationId: ConfigMgmt_GetNodeMetadataCounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodeMetadataCounts'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: type
        description: Types of node fields to collect value counts for.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: filter
        description: Filters to apply to the counts returned.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: start
        description: Earliest most recent check-in node information to return.
        in: query
        required: false
        type: string
      - name: end
        description: Latest most recent check-in node information to return.
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/node_runs_daily_status_time_series:
    get:
      summary: GetNodeRunsDailyStatusTimeSeries
      description: "Provides the status of runs for each 24-hour duration. For multiple runs in one 24-hour duration, \nthe most recent failed run will be returned. If there are no failed runs the most recent successful \nrun will be returned. If no runs are found in the 24-hour duration, the status will be \"missing\" \nand no run information will be returned.\n\nExample:\nrequest\n```\ncfgmgmt/node_runs_daily_status_time_series?node_id=507bd518-5c18-4c2d-a445-60fe7dde9961&days_ago=3\n```\nresponse\n```\n{\n\"durations\": [\n{\n\"start\": \"2020-04-25T19:00:00Z\",\n\"end\": \"2020-04-26T18:59:59Z\",\n\"status\": \"missing\",\n\"run_id\": \"\"\n},\n{\n\"start\": \"2020-04-26T19:00:00Z\",\n\"end\": \"2020-04-27T18:59:59Z\",\n\"status\": \"missing\",\n\"run_id\": \"\"\n},\n{\n\"start\": \"2020-04-27T19:00:00Z\",\n\"end\": \"2020-04-28T18:59:59Z\",\n\"status\": \"failure\",\n\"run_id\": \"b7904f41-68b5-44ec-9da6-cf2481ff8600\"\n}\n]\n}\n```\n\nAuthorization Action:\n```\ninfra:nodes:list\n```"
      operationId: ConfigMgmt_GetNodeRunsDailyStatusTimeSeries
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodeRunsDailyStatusTimeSeries'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: node_id
        description: Node ID of the runs.
        in: query
        required: false
        type: string
      - name: days_ago
        description: Number of past days.
        in: query
        required: false
        type: integer
        format: int32
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/nodes:
    get:
      summary: List Checked-in Nodes
      description: 'Returns a list of infra nodes that have checked in to Automate.

        Adding a filter makes a list of all nodes that meet the filter criteria.

        Filters for the same field are ORd together, while filters across different fields are ANDed together.

        Supports pagination, filtering (with wildcard support), and sorting.

        Max return payload size is 4MB, use pagination to fetch remaining data.


        Example:

        ```

        cfgmgmt/nodes?pagination.page=1&pagination.size=100&sorting.field=name&sorting.order=ASC&filter=name:mySO*&filter=platform:ubun*

        ```


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetNodes
      responses:
        '200':
          description: A successful response.
          schema:
            type: array
            items:
              type: object
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: Filters to apply to the request for nodes list.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: pagination.page
        description: Page number of the results to return.
        in: query
        required: false
        type: integer
        format: int32
      - name: pagination.size
        description: Amount of results to include per page.
        in: query
        required: false
        type: integer
        format: int32
      - name: sorting.field
        description: Field to sort the list results on.
        in: query
        required: false
        type: string
      - name: sorting.order
        description: Order the results should be returned in.
        in: query
        required: false
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
      - name: start
        description: Earliest most recent check-in node information to return.
        in: query
        required: false
        type: string
      - name: end
        description: Latest most recent check-in node information to return.
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/nodes/{node_id}/attribute:
    get:
      summary: Show Attributes
      description: 'Returns the latest reported attributes for the provided node ID.


        Authorization Action:

        ```

        infra:nodes:get

        ```'
      operationId: ConfigMgmt_GetAttributes
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodeAttribute'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: node_id
        description: Chef guid for the requested node.
        in: path
        required: true
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/nodes/{node_id}/runs:
    get:
      summary: List Run Details
      description: 'Returns a list of run metadata (id, start and end time, and status) for the provided node ID.

        Supports pagination.

        Accepts a `start` parameter to denote start date for the list and a filter of type `status`.


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetRuns
      responses:
        '200':
          description: A successful response.
          schema:
            type: array
            items:
              type: object
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: node_id
        description: Chef guid for the node.
        in: path
        required: true
        type: string
      - name: filter
        description: Filters to apply to the request for runs list.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: pagination.page
        description: Page number of the results to return.
        in: query
        required: false
        type: integer
        format: int32
      - name: pagination.size
        description: Amount of results to include per page.
        in: query
        required: false
        type: integer
        format: int32
      - name: start
        description: Earliest (in history) run information to return for the runs list.
        in: query
        required: false
        type: string
      - name: end
        description: Latest (in history) run information to return for the runs list.
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/nodes/{node_id}/runs/{run_id}:
    get:
      summary: Show Node Run
      description: 'Returns the infra run report for the provided node ID and run ID.


        Authorization Action:

        ```

        infra:nodes:get

        ```'
      operationId: ConfigMgmt_GetNodeRun
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.Run'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: node_id
        description: Chef guid for the requested node.
        in: path
        required: true
        type: string
      - name: run_id
        description: Run id for the node.
        in: path
        required: true
        type: string
      - name: end_time
        description: End time on the node's run.
        in: query
        required: false
        type: string
        format: date-time
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/organizations:
    get:
      summary: List Organizations
      description: 'Returns a list of all organizations associated with nodes that have checked in to Automate.


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetOrganizations
      responses:
        '200':
          description: A successful response.
          schema:
            type: array
            items:
              type: object
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/policy_revision/{revision_id}:
    get:
      summary: List Policy Cookbooks
      description: "Returns Policy Names with a list of cookbook names and associated policy identifiers based on a policy revision ID. \nPolicy revision IDs are sent with an infra run report and identifies which instance of a policy the node used for this run.\n\nAuthorization Action:\n```\ninfra:nodes:list\n```"
      operationId: ConfigMgmt_GetPolicyCookbooks
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.PolicyCookbooks'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: revision_id
        description: Revision id for the policy.
        in: path
        required: true
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/source_fqdns:
    get:
      summary: List Associated Chef Infra Servers
      description: 'Returns a list of all Chef Infra Servers associated with nodes that have checked in to Automate.


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetSourceFqdns
      responses:
        '200':
          description: A successful response.
          schema:
            type: array
            items:
              type: object
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/stats/checkin_counts_timeseries:
    get:
      summary: List Node Checkins
      description: 'Returns a daily time series of unique node check-ins for the number of days requested.

        If `days ago` value is empty, API will return the default 1 day ago results.


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetCheckInCountsTimeSeries
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.CheckInCountsTimeSeries'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: List of filters to be applied to the time series.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: days_ago
        description: Number of past days to create the time series.
        in: query
        required: false
        type: integer
        format: int32
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/stats/missing_node_duration_counts:
    get:
      summary: List Missing Nodes Count
      description: 'Returns a count of missing nodes for the provided durations.


        Example:

        ```

        cfgmgmt/stats/missing_node_duration_counts?durations=3d&durations=1w&durations=2w&durations=1M&durations=3M

        ```


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetMissingNodeDurationCounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.MissingNodeDurationCounts'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: durations
        description: "A valid duration is any number zero or greater with one of these characters 'h', 'd', 'w', or 'M'. \n'h' is hours\n'd' is days\n'w' is weeks\n'M' is months\nWill contain one or many."
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/stats/node_counts:
    get:
      summary: List Node Status Counts
      description: 'Returns totals for failed, success, missing, and overall total infra nodes that have reported into Automate.

        Supports filtering.


        Example:

        ```

        cfgmgmt/stats/node_counts?filter=name:mySO*&filter=platform:ubun*

        ```


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetNodesCounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodesCounts'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: List of filters to be applied to the node count results.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: start
        description: Earliest node check-in.
        in: query
        required: false
        type: string
      - name: end
        description: Latest node check-in.
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/stats/run_counts:
    get:
      summary: List Run Status Totals
      description: 'Returns totals for failed and successful runs given a `node_id`.


        Example:

        ```

        cfgmgmt/stats/run_counts?node_id=821fff07-abc9-4160-96b1-83d68ae5cfdd&start=2019-11-02

        ```


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetRunsCounts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.RunsCounts'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: filter
        description: List of filters to be applied to the run count results.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: start
        description: Earliest (in history) run information to return for the run counts.
        in: query
        required: false
        type: string
      - name: end
        description: Latest (in history) run information to return for the run counts.
        in: query
        required: false
        type: string
      - name: node_id
        description: Node id associated with the run.
        in: query
        required: false
        type: string
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/suggestions:
    get:
      summary: List Filter Suggestions
      description: 'Returns possible filter values given a valid `type` parameter. All values returned until two or more characters are provided for the `text` parameter.

        Supports wildcard (* and ?).


        Example:

        ```

        cfgmgmt/suggestions?type=environment&text=_d

        ```


        Authorization Action:

        ```

        infra:nodes:list

        ```'
      operationId: ConfigMgmt_GetSuggestions
      responses:
        '200':
          description: A successful response.
          schema:
            type: array
            items:
              type: object
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: type
        description: Field for which suggestions are being returned.
        in: query
        required: false
        type: string
      - name: text
        description: Text to search on for the type value.
        in: query
        required: false
        type: string
      - name: filter
        description: Filters to be applied to the results.
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/telemetry/nodes/count:
    get:
      summary: GetNodesUsageCount
      description: 'Returns the count of unique nodes with lastRun in a given time.

        The time duration can be between the last time Telemetry data sent and the day before the current date.

        If the duration < 15 days --> 15 days

        duration > 15 days --> duration

        Authorization Action:

        ```

        iam:introspect:getAll

        ```'
      operationId: ConfigMgmt_GetNodesUsageCount
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.GetNodesUsageCountResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      tags:
      - ConfigMgmt
  /api/v0/cfgmgmt/telemetry/nodes/count/updated:
    put:
      summary: 'UpdateTelemetryReported

        Acknowledge API  to updates the last client run telemetry reported date in postgres

        Authorization Action:

        ```

        iam:introspect:getAll

        ```'
      operationId: ConfigMgmt_UpdateTelemetryReported
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/chef.automate.api.cfgmgmt.response.UpdateTelemetryReportedResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.request.UpdateTelemetryReportedRequest'
      tags:
      - ConfigMgmt
definitions:
  chef.automate.api.cfgmgmt.response.RunList:
    type: object
    properties:
      type:
        type: string
        description: Type of run list item (e.g. 'recipe').
      name:
        type: string
        description: Name of run list item.
      version:
        type: string
        description: Version of run list item.
      skipped:
        type: boolean
        description: Boolean denoting whether or not the run list item was skipped.
      children:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.RunList'
        description: Intentionally blank.
  chef.automate.api.cfgmgmt.response.Errors:
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.ErrorCount'
    description: 'Errors contains a list of the most common Chef Infra error type/message

      combinations among nodes in the active project as filtered according to the

      request.'
  chef.automate.api.cfgmgmt.response.PolicyCookbooks:
    type: object
    properties:
      policy_name:
        type: string
        description: Name of the policy.
      cookbook_locks:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.CookbookLock'
        description: Intentionally blank.
  chef.automate.api.cfgmgmt.response.VersionedCookbook:
    type: object
    properties:
      name:
        type: string
        description: Name of the cookbook.
      version:
        type: string
        description: Version of the cookbook.
  chef.automate.api.cfgmgmt.response.NodesCounts:
    type: object
    properties:
      total:
        type: integer
        format: int32
        description: Total count of nodes that have reported in to Automate.
      success:
        type: integer
        format: int32
        description: Total count of nodes that have reported in to Automate whose last run was successful.
      failure:
        type: integer
        format: int32
        description: Total count of nodes that have reported in to Automate whose last run was failed.
      missing:
        type: integer
        format: int32
        description: Total count of nodes that have been labeled as 'missing' as determined by node lifecycle settings.
  chef.automate.api.cfgmgmt.response.GetNodesUsageCountResponse:
    type: object
    properties:
      days_since_last_post:
        type: string
        format: int64
        title: number of days since telematics was last posted
      node_cnt:
        type: string
        format: int64
        title: unique nodes count in a duration
  chef.automate.api.cfgmgmt.response.NodeSegmentsWithRolloutProgress:
    type: object
    properties:
      node_segment_rollout_progress:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.NodeSegmentRolloutProgress'
        description: 'The NodeSegmentRolloutProgress are sorted by policy group, policy

          name, then domain URL.'
    description: 'A Node Segment is the set of Chef Infra nodes with a shared policy_name,

      policy_node_group, and policy_domain_url.


      NodeSegmentsWithRolloutProgress lists all of the node segments matching the

      request with information about the progress and status of the code rollouts for each segment.'
    title: NodeSegmentsWithRolloutProgress
  chef.automate.api.cfgmgmt.response.NodeRunsDailyStatusTimeSeries:
    type: object
    properties:
      durations:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.RunDurationStatus'
        title: runs status of a 24-hour duration
  chef.automate.api.cfgmgmt.response.CheckInCountsTimeSeries:
    type: object
    properties:
      counts:
        type: array
        items:
          $ref: '#/definitions/chef.automate.api.cfgmgmt.response.CheckInCounts'
        title: List of daily checkin counts
  chef.automate.api.cfgmgmt.request.CreateRolloutTest:
    type: object
  google.protobuf.Any:
    type: object
    properties:
      type_url:
        type: string
        description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chef-software/refs/heads/main/openapi/chef-software-configmgmt-api-openapi.yml