delete.yaml

openapi: 3.0.0
info:
  title: Deletions
  version: '1'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/ccu/v3
x-akamai:
  auth-type: EDGE_GRID
  file-path: delete.yaml
paths:
  /delete/cpcode/{network}:
    parameters:
    - $ref: parameters/network-path.yaml
    post:
      operationId: post-delete-cpcode
      summary: Delete by CP code
      tags:
      - CP code
      description: |
        Deletes content on the selected CP code for the selected `network`. In most cases, you should [invalidate](ref:invalidate-cpcode) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.
      requestBody:
        required: true
        content:
          application/json:
            example:
              $ref: examples/post-cpcode.json
            schema:
              $ref: schemas/post-cpcode.yaml
      responses:
        201:
          description: |
            Successful POST of a purge request.
          content:
            application/json:
              example:
                $ref: examples/201.json
              schema:
                $ref: schemas/response.yaml
        400:
          description: |
            Bad request.
          content:
            application/problem+json:
              schema:
                $ref: schemas/response.yaml
        403:
          description: |
            Forbidden request.
          content:
            application/problem+json:
              example:
                $ref: examples/403.json
              schema:
                $ref: schemas/response.yaml
        429:
          description: |
            Too many requests.
          content:
            application/json:
              example:
                $ref: examples/cpcode-429.json
              schema:
                $ref: schemas/response.yaml
        500:
          description: |
            Internal server error.
          content:
            application/json:
              example:
                $ref: examples/500.json
              schema:
                $ref: schemas/response.yaml
  /delete/tag/{network}:
    parameters:
    - $ref: parameters/network-path.yaml
    post:
      operationId: post-delete-tag
      summary: Delete by cache tag
      tags:
      - Cache tag
      description: |
        Deletes content on the selected set of cache tags for the selected `network`. In most cases, you should [invalidate](ref:invalidate-tag) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.
      requestBody:
        required: true
        content:
          application/json:
            example:
              $ref: examples/post-tag.json
            schema:
              $ref: schemas/post-tag.yaml
      responses:
        201:
          description: |
            Successful POST of a purge request.
          content:
            application/json:
              example:
                $ref: examples/201.json
              schema:
                $ref: schemas/response.yaml
        400:
          description: |
            Bad request.
          content:
            application/problem+json:
              schema:
                $ref: schemas/response.yaml
        403:
          description: |
            Forbidden request.
          content:
            application/problem+json:
              example:
                $ref: examples/403.json
              schema:
                $ref: schemas/response.yaml
        429:
          description: |
            Too many requests.
          content:
            application/json:
              example:
                $ref: examples/tag-429.json
              schema:
                $ref: schemas/response.yaml
        500:
          description: |
            Internal server error.
          content:
            application/json:
              example:
                $ref: examples/500.json
              schema:
                $ref: schemas/response.yaml
  /delete/url/{network}:
    parameters:
    - $ref: parameters/network-path.yaml
    post:
      operationId: post-delete-url
      summary: Delete by URL or ARL
      tags:
      - URL/ARL
      description: |
        Deletes content on the selected URL or ARL  for the selected `network`.  URLs and ARLs can be submitted in the same request. In most cases, you should [invalidate](ref:invalidate-url) rather than delete content. Invalidation keeps each object in cache until the version on your origin server is newer. Deletion retrieves the object regardless, which can dramatically increase the load on your origin server and would prevent Akamai from serving the old content if your origin is unreachable.
      requestBody:
        required: true
        content:
          application/json:
            example:
              $ref: examples/post-url.json
            schema:
              $ref: schemas/post-url.yaml
      responses:
        201:
          description: |
            Successful POST of a purge request.
          content:
            application/json:
              example:
                $ref: examples/201.json
              schema:
                $ref: schemas/response.yaml
        400:
          description: |
            Bad request.
          content:
            application/problem+json:
              schema:
                $ref: schemas/response.yaml
        403:
          description: |
            Forbidden request.
          content:
            application/problem+json:
              example:
                $ref: examples/403.json
              schema:
                $ref: schemas/response.yaml
        429:
          description: |
            Too many requests.
          content:
            application/json:
              example:
                $ref: examples/url-429.json
              schema:
                $ref: schemas/response.yaml
        500:
          description: |
            Internal server error.
          content:
            application/json:
              example:
                $ref: examples/500.json
              schema:
                $ref: schemas/response.yaml