Palo Alto Networks Associate Rulestacks API

openapi: 3.2.0
info:
  contact: {}
  description: "Cloud NGFW for AWS supports local and global rulestacks. The Local Account Administrator manages local rulestacks. The AWS Firewall Manager Administrator manages the global rulestacks across the NGFWs in different AWS accounts within the AWS organization.\nThe AWS Firewall Manager Administrator can author a Firewall Manager Service (FMS) policy and associate a global rulestack to it.\n\n>**Note:** The maximum local and global rulestacks you can create per subscription is 10.\n>**Note:** A Local Account Administrator cannot create a FMS policy. When a FMS service handshake is established, any existing Local Account Administrator calls are disabled.  \n"
  title: to NGFW Associate Rulestacks API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: AssociateRulestacks
paths:
  /v1/config/ngfirewalls/{ngfirewallname}/globalrulestack:
    put:
      description: 'Associate a global rulestack to an NGFW.

        '
      operationId: put-v1-config-ngfirewalls-ngfirewallname-globalrulestack
      parameters:
      - description: 'The name of the NGFW to which you want to associate the global rulestack.

          '
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateGlobalRuleStackRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateGlobalRuleStackResponse'
          description: OK
      summary: Associate a GlobalRuleStack
      tags:
      - AssociateRulestacks
  /v1/config/ngfirewalls/{ngfirewallname}/rulestack:
    put:
      description: 'Associate a local rulestack to an NGFW.

        '
      operationId: put-v1-config-ngfirewalls-ngfirewallname-rulestack
      parameters:
      - description: 'The name of the NGFW to which you want to associate the local rulestack.

          '
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateRuleStackRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociateRuleStackResponse'
          description: OK
      summary: Associate a RuleStack
      tags:
      - AssociateRulestacks
components:
  schemas:
    AssociateRuleStackResponse.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* InvalidOperationException—Operation failed because it is not valid. For example, when you delete an NGFW or rulestack in use.\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* ResourceNotFoundException—Unable to locate a resource using the parameters you provided.\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
    AssociateGlobalRuleStackResponse:
      additionalProperties: false
      properties:
        AccountId:
          description: 'The unique ID of the global rulestack account.

            '
          title: Accountid
          type: string
        FirewallName:
          description: "Name of the NGFW, unique in a region for each customer. \n"
          title: Firewallname
          type: string
        ResponseStatus:
          $ref: '#/components/schemas/AssociateGlobalRuleStackResponse.Result'
          description: 'The API call response status.

            '
        RuleStackName:
          description: "Name of the global rulestack you want to associate to NGFW. \n"
          title: Rulestackname
          type: string
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      title: AssociateGlobalRuleStackResponse
      type: object
    AssociateGlobalRuleStackRequest:
      additionalProperties: false
      properties:
        AccountId:
          description: 'The unique ID of the global rulestack account.

            '
          title: Accountid
          type: string
        RuleStackName:
          description: "Name of the global rulestack you want to associate to NGFW. \n"
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Rulestackname
          type: string
        UpdateToken:
          description: "Refresh token. \n"
          title: Updatetoken
          type: string
      required:
      - RuleStackName
      - AccountId
      title: AssociateGlobalRuleStackRequest
      type: object
    AssociateGlobalRuleStackResponse.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* InvalidOperationException—Operation failed because it is not valid. For example, when you delete an NGFW or rulestack in use.\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* ResourceNotFoundException—Unable to locate a resource using the parameters you provided.\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
    AssociateRuleStackRequest:
      additionalProperties: false
      properties:
        AccountId:
          description: 'The unique ID of the local rulestack account.

            '
          title: Accountid
          type: string
        RuleStackName:
          description: "Name of the local rulestack you want to associate to NGFW. \n"
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
          title: Rulestackname
          type: string
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      required:
      - RuleStackName
      - AccountId
      title: AssociateRuleStackRequest
      type: object
    AssociateRuleStackResponse:
      additionalProperties: false
      properties:
        AccountId:
          description: 'The unique ID of the local rulestack account.

            '
          title: Accountid
          type: string
        FirewallName:
          description: "Name of the NGFW, unique in a region for each customer. \n"
          title: Firewallname
          type: string
        ResponseStatus:
          $ref: '#/components/schemas/AssociateRuleStackResponse.Result'
          description: 'The API call response status.

            '
        RuleStackName:
          description: "Name of the local rulestack you want to associate to NGFW. \n"
          title: Rulestackname
          type: string
        UpdateToken:
          description: 'Refresh token.

            '
          title: Updatetoken
          type: string
      title: AssociateRuleStackResponse
      type: object