find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aws-waf:aws-waf-xss-match-set-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS WAF Xss Match Set API
  version: '2015-08-24'
  description: Generated from AWS's published Smithy model for AWS WAF. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://waf.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Xss Match Set
paths:
  /#CreateXssMatchSet:
    post:
      operationId: CreateXssMatchSet
      summary: Create Xss Match Set
      description: 'This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateXssMatchSetResponse'
              example:
                XssMatchSet:
                  Name: MySampleXssMatchSet
                  XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
                  XssMatchTuples:
                  - FieldToMatch:
                      Type: QUERY_STRING
                    TextTransformation: URL_DECODE
                ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
        '400':
          description: WAFDisallowedNameException; WAFInvalidAccountException; WAFInvalidParameterException; WAFLimitsExceededException; WAFStaleDataException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFDisallowedNameException'
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20150824.CreateXssMatchSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateXssMatchSetRequest'
            example:
              Name: MySampleXssMatchSet
              ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
      tags:
      - Xss Match Set
  /#DeleteXssMatchSet:
    post:
      operationId: DeleteXssMatchSet
      summary: Delete Xss Match Set
      description: 'This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Permanently deletes an XssMatchSet. You can''t delete an XssMatchSet if it''s still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteXssMatchSetResponse'
              example:
                ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidAccountException; WAFNonEmptyEntityException; WAFNonexistentItemException; WAFReferencedItemException; WAFStaleDataException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidAccountException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20150824.DeleteXssMatchSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteXssMatchSetRequest'
            example:
              XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
              ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
      tags:
      - Xss Match Set
  /#GetXssMatchSet:
    post:
      operationId: GetXssMatchSet
      summary: Get Xss Match Set
      description: This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the XssMatchSet that is specified by XssMatchSetId.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetXssMatchSetResponse'
              example:
                XssMatchSet:
                  Name: MySampleXssMatchSet
                  XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
                  XssMatchTuples:
                  - FieldToMatch:
                      Type: QUERY_STRING
                    TextTransformation: URL_DECODE
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidAccountException; WAFNonexistentItemException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidAccountException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20150824.GetXssMatchSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetXssMatchSetRequest'
            example:
              XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
      tags:
      - Xss Match Set
  /#ListXssMatchSets:
    post:
      operationId: ListXssMatchSets
      summary: List Xss Match Sets
      description: This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of XssMatchSet objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListXssMatchSetsResponse'
              example:
                XssMatchSets:
                - Name: MySampleXssMatchSet
                  XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidAccountException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidAccountException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20150824.ListXssMatchSets
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListXssMatchSetsRequest'
            example:
              Limit: 100
      tags:
      - Xss Match Set
  /#UpdateXssMatchSet:
    post:
      operationId: UpdateXssMatchSet
      summary: Update Xss Match Set
      description: 'This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you''re receiving requests that contain cross-site scripting attacks in the request body and you want to blo'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateXssMatchSetResponse'
              example:
                ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
        '500':
          description: WAFInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInternalErrorException'
        '400':
          description: WAFInvalidAccountException; WAFInvalidOperationException; WAFInvalidParameterException; WAFLimitsExceededException; WAFNonexistentContainerException; WAFNonexistentItemException; WAFStaleDataException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/WAFInvalidAccountException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSWAF_20150824.UpdateXssMatchSet
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateXssMatchSetRequest'
            example:
              XssMatchSetId: example1ds3t-46da-4fdb-b8d5-abc321j569j5
              ChangeToken: abcd12f2-46da-4fdb-b8d5-fbd4c466928f
              Updates:
              - Action: DELETE
                XssMatchTuple:
                  FieldToMatch:
                    Type: QUERY_STRING
                  TextTransformation: URL_DECODE
      tags:
      - Xss Match Set
components:
  schemas:
    CreateXssMatchSetResponse:
      type: object
      properties:
        XssMatchSet:
          $ref: '#/components/schemas/XssMatchSet'
        ChangeToken:
          type: string
          description: The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
    GetXssMatchSetResponse:
      type: object
      properties:
        XssMatchSet:
          $ref: '#/components/schemas/XssMatchSet'
    ListXssMatchSetsResponse:
      type: object
      properties:
        NextMarker:
          type: string
          description: If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
        XssMatchSets:
          type: array
          items:
            $ref: '#/components/schemas/XssMatchSetSummary'
          description: An array of XssMatchSetSummary objects.
    ListXssMatchSetsRequest:
      type: object
      properties:
        NextMarker:
          type: string
          description: If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.
        Limit:
          type: integer
          description: Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
    GetXssMatchSetRequest:
      type: object
      properties:
        XssMatchSetId:
          type: string
          description: The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
      required:
      - XssMatchSetId
    UpdateXssMatchSetRequest:
      type: object
      properties:
        XssMatchSetId:
          type: string
          description: The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
        ChangeToken:
          type: string
          description: The value returned by the most recent call to GetChangeToken.
        Updates:
          type: array
          items:
            $ref: '#/components/schemas/XssMatchSetUpdate'
          description: 'An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types: XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type'
      required:
      - XssMatchSetId
      - ChangeToken
      - Updates
    DeleteXssMatchSetRequest:
      type: object
      properties:
        XssMatchSetId:
          type: string
          description: The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
        ChangeToken:
          type: string
          description: The value returned by the most recent call to GetChangeToken.
      required:
      - XssMatchSetId
      - ChangeToken
    WAFInvalidAccountException:
      type: object
      properties: {}
    WAFDisallowedNameException:
      type: object
      properties:
        message:
          type: string
    UpdateXssMatchSetResponse:
      type: object
      properties:
        ChangeToken:
          type: string
          description: The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
    XssMatchSet:
      type: object
      properties:
        XssMatchSetId:
          type: string
          description: A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
        Name:
          type: string
          description: The name, if any, of the XssMatchSet.
        XssMatchTuples:
          type: array
          items:
            $ref: '#/components/schemas/XssMatchTuple'
          description: Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
      required:
      - XssMatchSetId
      - XssMatchTuples
    WAFInternalErrorException:
      type: object
      properties:
        message:
          type: string
    CreateXssMatchSetRequest:
      type: object
      properties:
        Name:
          type: string
          description: A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.
        ChangeToken:
          type: string
          description: The value returned by the most recent call to GetChangeToken.
      required:
      - Name
      - ChangeToken
    DeleteXssMatchSetResponse:
      type: object
      properties:
        ChangeToken:
          type: string
          description: The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
    XssMatchTuple:
      type: object
      properties:
        FieldToMatch:
          $ref: '#/components/schemas/FieldToMatch'
        TextTransformation:
          type: string
          enum:
          - NONE
          - COMPRESS_WHITE_SPACE
          - HTML_ENTITY_DECODE
          - LOWERCASE
          - CMD_LINE
          - URL_DECODE
          description: 'Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you''re concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " '' ^ Delete spaces before the '
      required:
      - FieldToMatch
      - TextTransformation
    FieldToMatch:
      type: object
      properties:
        Type:
          type: string
          enum:
          - URI
          - QUERY_STRING
          - HEADER
          - METHOD
          - BODY
          - SINGLE_QUERY_ARG
          - ALL_QUERY_ARGS
          description: 'The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: A query string, which is the part of a URL that appears '
        Data:
          type: string
          description: When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data.
      required:
      - Type
    XssMatchSetUpdate:
      type: object
      properties:
        Action:
          type: string
          enum:
          - INSERT
          - DELETE
          description: Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.
        XssMatchTuple:
          $ref: '#/components/schemas/XssMatchTuple'
      required:
      - Action
      - XssMatchTuple
    XssMatchSetSummary:
      type: object
      properties:
        XssMatchSetId:
          type: string
          description: A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
        Name:
          type: string
          description: The name of the XssMatchSet, if any, specified by Id.
      required:
      - XssMatchSetId
      - Name
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: waf
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/waf/service/2015-08-24/waf-2015-08-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)