openapi: 3.2.0
info:
  contact: {}
  description: 'Manage commits for rulestacks.

    '
  title: Manage Rulestack Commits Manage Commit Configuration API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: ManageCommitConfiguration
paths:
  /v1/config/rulestacks/{rulestackname}/commit:
    get:
      description: 'View the commit status of a specified rulestack.

        '
      operationId: get-v1-config-rulestacks-rulestackname-commit
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeCommitRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeCommitResponse'
          description: OK
      summary: Describe commit status for a RuleStack
      tags:
      - ManageCommitConfiguration
    post:
      description: 'Commit a specified rulestack.

        '
      operationId: post-v1-config-rulestacks-rulestackname-commit
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommitRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitResponse'
          description: OK
      summary: Commit a RuleStack
      tags:
      - ManageCommitConfiguration
  /v1/config/rulestacks/{rulestackname}/revert:
    post:
      description: 'Revert all uncommitted changes for a specified rulestack.

        '
      operationId: post-v1-config-rulestacks-rulestackname-revert
      parameters:
      - description: "The name of the rulestack.  \n"
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevertRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevertResponse'
          description: OK
      summary: Revert a RuleStack
      tags:
      - ManageCommitConfiguration
  /v1/config/rulestacks/{rulestackname}/validate:
    post:
      description: 'Validate a rulestack after commit.

        '
      operationId: post-v1-config-rulestacks-rulestackname-validate
      parameters:
      - description: 'The name of the rulestack.

          '
        in: path
        name: rulestackname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateResponse'
          description: OK
      summary: Validate a RuleStack
      tags:
      - ManageCommitConfiguration
components:
  schemas:
    DescribeCommitResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/DescribeCommitResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/DescribeCommitResponse.Result'
      title: DescribeCommitResponse
      type: object
    RevertRequest:
      additionalProperties: false
      properties: {}
      title: RevertRequest
      type: object
    ValidateResponse:
      additionalProperties: false
      properties:
        ResponseStatus:
          $ref: '#/components/schemas/ValidateResponse.Result'
          description: 'Commit status.

            '
        RuleStackName:
          description: 'Name of the rulestack.

            '
          title: Rulestackname
          type: string
      title: ValidateResponse
      type: object
    CommitResponse:
      additionalProperties: false
      properties:
        ResponseStatus:
          $ref: '#/components/schemas/CommitResponse.Result'
          description: 'Commit status.

            '
        RuleStackName:
          description: 'Name of the rulestack.

            '
          title: Rulestackname
          type: string
      title: CommitResponse
      type: object
    CommitRequest:
      additionalProperties: false
      properties: {}
      title: CommitRequest
      type: object
    ValidateRequest:
      additionalProperties: false
      properties: {}
      title: ValidateRequest
      type: object
    ValidateResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.   \n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n"
          title: Errorcode
          type: integer
        Reason:
          description: "The error description. \n"
          title: Reason
          type: string
      title: Result
      type: object
    CommitResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.   \n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n"
          title: Errorcode
          type: integer
        Reason:
          description: "The error description. \n"
          title: Reason
          type: string
      title: Result
      type: object
    DescribeCommitResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.   \n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n"
          title: Errorcode
          type: integer
        Reason:
          description: 'The error description.

            '
          title: Reason
          type: string
      title: Result
      type: object
    RevertResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          description: "Default value of a successful response is 0. Any other number indicates an error code.  \n\n400—HTTP bad request\n* InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.\n* LimitExceededException—Operation failed due to violation in limit settings.\n* ThrottlingException—Operation failed due to throttling limitations.   \n\n500—Bad request \n* InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.\n"
          title: Errorcode
          type: integer
        Reason:
          description: "The error description. \n"
          title: Reason
          type: string
      title: Result
      type: object
    RevertResponse:
      additionalProperties: false
      properties:
        ResponseStatus:
          $ref: '#/components/schemas/RevertResponse.Result'
          description: 'Commit status.

            '
        RuleStackName:
          description: 'Name of the rulestack.

            '
          title: Rulestackname
          type: string
      title: RevertResponse
      type: object
    DescribeCommitResponse.ResponseData:
      additionalProperties: false
      properties:
        CommitMessages:
          description: 'Rulestack commit message.

            '
          items:
            type: string
          title: Commitmessages
          type: array
        CommitStatus:
          description: 'Rulestack commit status.

            '
          title: Commitstatus
          type: string
        RuleStackName:
          description: 'Name of the rulestack.

            '
          title: Rulestackname
          type: string
        ValidateMessages:
          description: 'Validate rulestack commit.

            '
          items:
            type: string
          title: Validatemessages
          type: array
        ValidateStatus:
          description: 'Rulestack validation status.

            '
          title: Validatestatus
          type: string
      title: ResponseData
      type: object
    DescribeCommitRequest:
      additionalProperties: false
      properties: {}
      title: DescribeCommitRequest
      type: object